com.liferay.marketplace.service

Interface ModuleLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

ModuleLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface ModuleLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for Module. 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:

ModuleLocalServiceUtil, com.liferay.marketplace.service.base.ModuleLocalServiceBaseImpl, com.liferay.marketplace.service.impl.ModuleLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
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)
Module	addModule(long appId, java.lang.String bundleSymbolicName, java.lang.String bundleVersion, java.lang.String contextName)
Module	addModule(Module module) Adds the module to the database.
Module	createModule(long moduleId) Creates a new module with the primary key.
Module	deleteModule(long moduleId) Deletes the module with the primary key from the database.
Module	deleteModule(Module module) Deletes the module from the database.
void	deleteModules(long appId)
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<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.
<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.
<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.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
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.
Module	fetchModule(long moduleId)
Module	fetchModule(long appId, java.lang.String bundleSymbolicName, java.lang.String bundleVersion, java.lang.String contextName)
Module	fetchModuleByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the module with the matching UUID and company.
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
Module	getModule(long moduleId) Returns the module with the primary key.
Module	getModuleByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the module with the matching UUID and company.
java.util.List<Module>	getModules(int start, int end) Returns a range of all the modules.
java.util.List<Module>	getModules(long appId)
int	getModulesCount() Returns the number of modules.
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
Module	updateModule(Module module) Updates the module in the database or adds it if it does not yet exist.

Method Detail

addModule

@Deprecated
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

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

Throws:

com.liferay.portal.kernel.exception.PortalException

addModule

Module addModule(long appId,
                 java.lang.String bundleSymbolicName,
                 java.lang.String bundleVersion,
                 java.lang.String contextName)
          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addModule

@Indexable(type=REINDEX)
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

@Transactional(enabled=false)
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

@Indexable(type=DELETE)
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.

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

@Indexable(type=DELETE)
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

void deleteModules(long appId)

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

<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.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

<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.

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.

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

<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.

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.

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

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

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 query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchModule

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Module fetchModule(long moduleId)

fetchModule

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Module fetchModule(long appId,
                                                                                      java.lang.String bundleSymbolicName,
                                                                                      java.lang.String bundleVersion,
                                                                                      java.lang.String contextName)

fetchModuleByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getModule

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Module getModuleByUuidAndCompanyId(java.lang.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 UUID

companyId - 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Module> getModules(long appId)

getModulesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getModulesCount()

Returns the number of modules.

Returns:

the number of modules

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

updateModule

@Indexable(type=REINDEX)
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