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:
Generated:
  • Method Summary

    Modifier and Type
    Method
    Description
    addModule(long appId, String bundleSymbolicName, String bundleVersion, String contextName)
     
    addModule(Module module)
    Adds the module to the database.
    createModule(long moduleId)
    Creates a new module with the primary key.
    com.liferay.portal.kernel.model.PersistedModel
     
    deleteModule(long moduleId)
    Deletes the module with the primary key from the database.
    Deletes the module from the database.
    void
    deleteModules(long appId)
     
    com.liferay.portal.kernel.model.PersistedModel
    deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
     
    <T> T
    dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
     
    int
    dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
     
    com.liferay.portal.kernel.dao.orm.DynamicQuery
     
    <T> List<T>
    dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
    Performs a dynamic query on the database and returns the matching rows.
    <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.
    <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.
    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.
    fetchModule(long moduleId)
     
    fetchModule(long appId, String bundleSymbolicName, String bundleVersion, String contextName)
     
    fetchModuleByUuidAndCompanyId(String uuid, long companyId)
    Returns the module with the matching UUID and company.
    com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
     
    com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
     
    getModule(long moduleId)
    Returns the module with the primary key.
    getModuleByUuidAndCompanyId(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)
     
    int
    Returns the number of modules.
    Returns the OSGi service identifier.
    com.liferay.portal.kernel.model.PersistedModel
     
    Updates the module in the database or adds it if it does not yet exist.

    Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

    fetchPersistedModel, getBasePersistence
  • Method Details

    • addModule

      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

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

      @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
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.

      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

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

      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
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

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

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

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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, String bundleSymbolicName, String bundleVersion, String contextName)
    • fetchModuleByUuidAndCompanyId

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Module> getModules(long appId)
    • getModulesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getModulesCount()
      Returns the number of modules.
      Returns:
      the number of modules
    • getOSGiServiceIdentifier

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

      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