@ProviderType
public class ModuleLocalServiceUtil
extends java.lang.Object
com.liferay.marketplace.service.impl.ModuleLocalServiceImpl
and is the
primary 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.ModuleLocalService
,
com.liferay.marketplace.service.base.ModuleLocalServiceBaseImpl
,
com.liferay.marketplace.service.impl.ModuleLocalServiceImpl
Constructor and Description |
---|
ModuleLocalServiceUtil() |
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 com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.model.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.
|
@Deprecated public static Module addModule(long userId, long appId, java.lang.String bundleSymbolicName, java.lang.String bundleVersion, java.lang.String contextName) throws com.liferay.portal.kernel.exception.PortalException
addModule(long,
String, String, String)
com.liferay.portal.kernel.exception.PortalException
public static Module addModule(long appId, java.lang.String bundleSymbolicName, java.lang.String bundleVersion, java.lang.String contextName) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static Module addModule(Module module)
module
- the modulepublic static Module createModule(long moduleId)
moduleId
- the primary key for the new modulepublic static Module deleteModule(long moduleId) throws com.liferay.portal.kernel.exception.PortalException
moduleId
- the primary key of the modulePortalException
- if a module with the primary key could not be foundpublic static Module deleteModule(Module module)
module
- the modulepublic static void deleteModules(long appId)
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
PortalException
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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 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 and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.marketplace.model.impl.ModuleModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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 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 and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.marketplace.model.impl.ModuleModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static Module fetchModule(long moduleId)
public static Module fetchModule(long appId, java.lang.String bundleSymbolicName, java.lang.String bundleVersion, java.lang.String contextName)
public static Module fetchModuleByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the module's UUIDcompanyId
- the primary key of the companynull
if a matching module could not be foundpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static Module getModule(long moduleId) throws com.liferay.portal.kernel.exception.PortalException
moduleId
- the primary key of the modulePortalException
- if a module with the primary key could not be foundpublic static Module getModuleByUuidAndCompanyId(java.lang.String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the module's UUIDcompanyId
- the primary key of the companyPortalException
- if a matching module could not be foundpublic static java.util.List<Module> getModules(int start, int end)
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 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 and pagination is required (start
and end
are not QueryUtil.ALL_POS
), then the query will include the default ORDER BY logic from com.liferay.marketplace.model.impl.ModuleModelImpl
. If both orderByComparator
and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
start
- the lower bound of the range of modulesend
- the upper bound of the range of modules (not inclusive)public static java.util.List<Module> getModules(long appId)
public static int getModulesCount()
public static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static Module updateModule(Module module)
module
- the modulepublic static ModuleLocalService getService()