Class ModuleLocalServiceUtil

java.lang.Object
com.liferay.marketplace.service.ModuleLocalServiceUtil

public class ModuleLocalServiceUtil extends 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:
Generated:
  • 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

      public static 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

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

      public static 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

      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

      public static <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

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

      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 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, String bundleSymbolicName, String bundleVersion, String contextName)
    • fetchModuleByUuidAndCompanyId

      public static 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

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

      public static 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 List<Module> getModules(long appId)
    • getModulesCount

      public static int getModulesCount()
      Returns the number of modules.
      Returns:
      the number of modules
    • getOSGiServiceIdentifier

      public static String 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

      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.

      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

      public static ModuleLocalService getService()