com.liferay.marketplace.service

Class ModuleLocalServiceUtil

java.lang.Object

com.liferay.marketplace.service.ModuleLocalServiceUtil

public class ModuleLocalServiceUtil
extends java.lang.Object

Provides the local service utility for Module. This utility wraps com.liferay.marketplace.service.impl.ModuleLocalServiceImpl and is an access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

ModuleLocalService

Constructor Summary

Constructors

Constructor and Description
ModuleLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Module	addModule(long userId, long appId, java.lang.String bundleSymbolicName, java.lang.String bundleVersion, java.lang.String contextName) Deprecated. As of Judson (7.1.x), replaced by addModule(long, String, String, String)
static Module	addModule(long appId, java.lang.String bundleSymbolicName, java.lang.String bundleVersion, java.lang.String contextName)
static Module	addModule(Module module) Adds the module to the database.
static Module	createModule(long moduleId) Creates a new module with the primary key.
static Module	deleteModule(long moduleId) Deletes the module with the primary key from the database.
static Module	deleteModule(Module module) Deletes the module from the database.
static void	deleteModules(long appId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static Module	fetchModule(long moduleId)
static Module	fetchModule(long appId, java.lang.String bundleSymbolicName, java.lang.String bundleVersion, java.lang.String contextName)
static Module	fetchModuleByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the module with the matching UUID and company.
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static Module	getModule(long moduleId) Returns the module with the primary key.
static Module	getModuleByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the module with the matching UUID and company.
static java.util.List<Module>	getModules(int start, int end) Returns a range of all the modules.
static java.util.List<Module>	getModules(long appId)
static int	getModulesCount() Returns the number of modules.
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static ModuleLocalService	getService()
static Module	updateModule(Module module) Updates the module in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModuleLocalServiceUtil

public ModuleLocalServiceUtil()

Method Detail

addModule

@Deprecated
public static Module addModule(long userId,
                                           long appId,
                                           java.lang.String bundleSymbolicName,
                                           java.lang.String bundleVersion,
                                           java.lang.String contextName)
                                    throws PortalException

Deprecated. As of Judson (7.1.x), replaced by addModule(long, String, String, String)

Throws:

PortalException

addModule

public static Module addModule(long appId,
                               java.lang.String bundleSymbolicName,
                               java.lang.String bundleVersion,
                               java.lang.String contextName)
                        throws PortalException

Throws:

PortalException

addModule

public static Module addModule(Module module)

Adds the module to the database. Also notifies the appropriate model listeners.

Parameters:

module - the module

Returns:

the module that was added

createModule

public static Module createModule(long moduleId)

Creates a new module with the primary key. Does not add the module to the database.

Parameters:

moduleId - the primary key for the new module

Returns:

the new module

deleteModule

public static Module deleteModule(long moduleId)
                           throws PortalException

Deletes the module with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

moduleId - the primary key of the module

Returns:

the module that was removed

Throws:

PortalException - if a module with the primary key could not be found

deleteModule

public static Module deleteModule(Module module)

Deletes the module from the database. Also notifies the appropriate model listeners.

Parameters:

module - the module

Returns:

the module that was removed

deleteModules

public static void deleteModules(long appId)

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.marketplace.model.impl.ModuleModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.marketplace.model.impl.ModuleModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchModule

public static Module fetchModule(long moduleId)

fetchModule

public static Module fetchModule(long appId,
                                 java.lang.String bundleSymbolicName,
                                 java.lang.String bundleVersion,
                                 java.lang.String contextName)

fetchModuleByUuidAndCompanyId

public static Module fetchModuleByUuidAndCompanyId(java.lang.String uuid,
                                                   long companyId)

Returns the module with the matching UUID and company.

Parameters:

uuid - the module's UUID

companyId - the primary key of the company

Returns:

the matching module, or null if a matching module could not be found

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getModule

public static Module getModule(long moduleId)
                        throws PortalException

Returns the module with the primary key.

Parameters:

moduleId - the primary key of the module

Returns:

the module

Throws:

PortalException - if a module with the primary key could not be found

getModuleByUuidAndCompanyId

public static Module getModuleByUuidAndCompanyId(java.lang.String uuid,
                                                 long companyId)
                                          throws PortalException

Returns the module with the matching UUID and company.

Parameters:

uuid - the module's UUID

companyId - the primary key of the company

Returns:

the matching module

Throws:

PortalException - if a matching module could not be found

getModules

public static java.util.List<Module> getModules(int start,
                                                int end)

Returns a range of all the modules.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.marketplace.model.impl.ModuleModelImpl.

Parameters:

start - the lower bound of the range of modules

end - the upper bound of the range of modules (not inclusive)

Returns:

the range of modules

getModules

public static java.util.List<Module> getModules(long appId)

getModulesCount

public static int getModulesCount()

Returns the number of modules.

Returns:

the number of modules

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

updateModule

public static Module updateModule(Module module)

Updates the module in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

module - the module

Returns:

the module that was updated

getService

public static ModuleLocalService getService()