Class DefinitionLocalServiceUtil

java.lang.Object
com.liferay.portal.reports.engine.console.service.DefinitionLocalServiceUtil

public class DefinitionLocalServiceUtil extends Object
Provides the local service utility for Definition. This utility wraps com.liferay.portal.reports.engine.console.service.impl.DefinitionLocalServiceImpl 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

    • DefinitionLocalServiceUtil

      public DefinitionLocalServiceUtil()
  • Method Details

    • addDefinition

      public static Definition addDefinition(Definition definition)
      Adds the definition to the database. Also notifies the appropriate model listeners.

      Important: Inspect DefinitionLocalServiceImpl 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:
      definition - the definition
      Returns:
      the definition that was added
    • addDefinition

      public static Definition addDefinition(long userId, long groupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, long sourceId, String reportParameters, String fileName, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createDefinition

      public static Definition createDefinition(long definitionId)
      Creates a new definition with the primary key. Does not add the definition to the database.
      Parameters:
      definitionId - the primary key for the new definition
      Returns:
      the new definition
    • 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
    • deleteDefinition

      public static Definition deleteDefinition(Definition definition) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the definition from the database. Also notifies the appropriate model listeners.

      Important: Inspect DefinitionLocalServiceImpl 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:
      definition - the definition
      Returns:
      the definition that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteDefinition

      public static Definition deleteDefinition(long definitionId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the definition with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect DefinitionLocalServiceImpl 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:
      definitionId - the primary key of the definition
      Returns:
      the definition that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a definition with the primary key could not be found
    • deleteDefinitions

      public static void deleteDefinitions(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteDefinitionTemplates

      public static void deleteDefinitionTemplates(long companyId, String attachmentsDirectory) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.portal.reports.engine.console.model.impl.DefinitionModelImpl.

      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.portal.reports.engine.console.model.impl.DefinitionModelImpl.

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

      public static Definition fetchDefinition(long definitionId)
    • fetchDefinitionByUuidAndGroupId

      public static Definition fetchDefinitionByUuidAndGroupId(String uuid, long groupId)
      Returns the definition matching the UUID and group.
      Parameters:
      uuid - the definition's UUID
      groupId - the primary key of the group
      Returns:
      the matching definition, or null if a matching definition could not be found
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getAttachmentsFileNames

      public static String[] getAttachmentsFileNames(Definition definition)
    • getDefinition

      public static Definition getDefinition(long definitionId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the definition with the primary key.
      Parameters:
      definitionId - the primary key of the definition
      Returns:
      the definition
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a definition with the primary key could not be found
    • getDefinitionByUuidAndGroupId

      public static Definition getDefinitionByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the definition matching the UUID and group.
      Parameters:
      uuid - the definition's UUID
      groupId - the primary key of the group
      Returns:
      the matching definition
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching definition could not be found
    • getDefinitions

      public static List<Definition> getDefinitions(int start, int end)
      Returns a range of all the definitions.

      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.portal.reports.engine.console.model.impl.DefinitionModelImpl.

      Parameters:
      start - the lower bound of the range of definitions
      end - the upper bound of the range of definitions (not inclusive)
      Returns:
      the range of definitions
    • getDefinitions

      public static List<Definition> getDefinitions(long groupId, String definitionName, String description, String sourceId, String reportName, boolean andSearch, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Definition> orderByComparator)
    • getDefinitionsByUuidAndCompanyId

      public static List<Definition> getDefinitionsByUuidAndCompanyId(String uuid, long companyId)
      Returns all the definitions matching the UUID and company.
      Parameters:
      uuid - the UUID of the definitions
      companyId - the primary key of the company
      Returns:
      the matching definitions, or an empty list if no matches were found
    • getDefinitionsByUuidAndCompanyId

      public static List<Definition> getDefinitionsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Definition> orderByComparator)
      Returns a range of definitions matching the UUID and company.
      Parameters:
      uuid - the UUID of the definitions
      companyId - the primary key of the company
      start - the lower bound of the range of definitions
      end - the upper bound of the range of definitions (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching definitions, or an empty list if no matches were found
    • getDefinitionsCount

      public static int getDefinitionsCount()
      Returns the number of definitions.
      Returns:
      the number of definitions
    • getDefinitionsCount

      public static int getDefinitionsCount(long groupId, String definitionName, String description, String sourceId, String reportName, boolean andSearch)
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • 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
    • updateDefinition

      public static Definition updateDefinition(Definition definition)
      Updates the definition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect DefinitionLocalServiceImpl 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:
      definition - the definition
      Returns:
      the definition that was updated
    • updateDefinition

      public static Definition updateDefinition(long definitionId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, long sourceId, String reportParameters, String fileName, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateDefinitionResources

      public static void updateDefinitionResources(Definition definition, String[] communityPermissions, String[] guestPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static DefinitionLocalService getService()