Class ModuleLocalServiceUtil
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:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Modulestatic ModuleAdds the module to the database.static ModulecreateModule(long moduleId) Creates a new module with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static ModuledeleteModule(long moduleId) Deletes the module with the primary key from the database.static ModuledeleteModule(Module module) Deletes the module from the database.static voiddeleteModules(long appId) static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> 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> 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> 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 longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(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 ModulefetchModule(long moduleId) static ModulefetchModule(long appId, String bundleSymbolicName, String bundleVersion, String contextName) static ModulefetchModuleByUuidAndCompanyId(String uuid, long companyId) Returns the module with the matching UUID and company.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic ModulegetModule(long moduleId) Returns the module with the primary key.static ModulegetModuleByUuidAndCompanyId(String uuid, long companyId) Returns the module with the matching UUID and company.getModules(int start, int end) Returns a range of all the modules.getModules(long appId) static intReturns the number of modules.static StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static ModuleLocalServicestatic ModuleupdateModule(Module module) Updates the module in the database or adds it if it does not yet exist.
-
Constructor Details
-
ModuleLocalServiceUtil
public ModuleLocalServiceUtil()
-
-
Method Details
-
addModule
public static Module addModule(long appId, String bundleSymbolicName, String bundleVersion, String contextName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addModule
Adds the module to the database. Also notifies the appropriate model listeners.Important: Inspect ModuleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
module- the module- Returns:
- the module that was added
-
createModule
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
-
createPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteModule
public static Module deleteModule(long moduleId) throws com.liferay.portal.kernel.exception.PortalException Deletes the module with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect ModuleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
moduleId- the primary key of the module- Returns:
- the module that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a module with the primary key could not be found
-
deleteModule
Deletes the module from the database. Also notifies the appropriate model listeners.Important: Inspect ModuleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
module- the module- Returns:
- the module that was removed
-
deleteModules
public static void deleteModules(long appId) -
deletePersistedModel
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
public static com.liferay.portal.kernel.dao.orm.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> 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.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.marketplace.model.impl.ModuleModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
public static <T> 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.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.marketplace.model.impl.ModuleModelImpl.- Parameters:
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 (optionallynull)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.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(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.- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchModule
-
fetchModule
-
fetchModuleByUuidAndCompanyId
Returns the module with the matching UUID and company.- Parameters:
uuid- the module's UUIDcompanyId- the primary key of the company- Returns:
- the matching module, or
nullif a matching module could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getModule
public static Module getModule(long moduleId) throws com.liferay.portal.kernel.exception.PortalException Returns the module with the primary key.- Parameters:
moduleId- the primary key of the module- Returns:
- the module
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a module with the primary key could not be found
-
getModuleByUuidAndCompanyId
public static Module getModuleByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException Returns the module with the matching UUID and company.- Parameters:
uuid- the module's UUIDcompanyId- the primary key of the company- Returns:
- the matching module
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a matching module could not be found
-
getModules
Returns a range of all the modules.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.marketplace.model.impl.ModuleModelImpl.- Parameters:
start- the lower bound of the range of modulesend- the upper bound of the range of modules (not inclusive)- Returns:
- the range of modules
-
getModules
-
getModulesCount
public static int getModulesCount()Returns the number of modules.- Returns:
- the number of modules
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateModule
Updates the module in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect ModuleLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
module- the module- Returns:
- the module that was updated
-
getService
-