Class DefinitionLocalServiceUtil
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DefinitionaddDefinition(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) static DefinitionaddDefinition(Definition definition) Adds the definition to the database.static DefinitioncreateDefinition(long definitionId) Creates a new definition with the primary key.static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static DefinitiondeleteDefinition(long definitionId) Deletes the definition with the primary key from the database.static DefinitiondeleteDefinition(Definition definition) Deletes the definition from the database.static voiddeleteDefinitions(long groupId) static voiddeleteDefinitionTemplates(long companyId, String attachmentsDirectory) 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 DefinitionfetchDefinition(long definitionId) static DefinitionfetchDefinitionByUuidAndGroupId(String uuid, long groupId) Returns the definition matching the UUID and group.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic String[]getAttachmentsFileNames(Definition definition) static DefinitiongetDefinition(long definitionId) Returns the definition with the primary key.static DefinitiongetDefinitionByUuidAndGroupId(String uuid, long groupId) Returns the definition matching the UUID and group.static List<Definition>getDefinitions(int start, int end) Returns a range of all the definitions.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) static List<Definition>getDefinitionsByUuidAndCompanyId(String uuid, long companyId) Returns all the definitions matching the UUID and company.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.static intReturns the number of definitions.static intgetDefinitionsCount(long groupId, String definitionName, String description, String sourceId, String reportName, boolean andSearch) static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static DefinitionLocalServicestatic DefinitionupdateDefinition(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) static DefinitionupdateDefinition(Definition definition) Updates the definition in the database or adds it if it does not yet exist.static voidupdateDefinitionResources(Definition definition, String[] communityPermissions, String[] guestPermissions)
-
Constructor Details
-
DefinitionLocalServiceUtil
public DefinitionLocalServiceUtil()
-
-
Method Details
-
addDefinition
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, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, long sourceId, String reportParameters, String fileName, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
createDefinition
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
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.portal.reports.engine.console.model.impl.DefinitionModelImpl.- 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.portal.reports.engine.console.model.impl.DefinitionModelImpl.- 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
-
fetchDefinition
-
fetchDefinitionByUuidAndGroupId
Returns the definition matching the UUID and group.- Parameters:
uuid- the definition's UUIDgroupId- the primary key of the group- Returns:
- the matching definition, or
nullif a matching definition could not be found
-
getActionableDynamicQuery
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getAttachmentsFileNames
-
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 UUIDgroupId- 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
Returns a range of all the definitions.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.portal.reports.engine.console.model.impl.DefinitionModelImpl.- Parameters:
start- the lower bound of the range of definitionsend- 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
Returns all the definitions matching the UUID and company.- Parameters:
uuid- the UUID of the definitionscompanyId- 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 definitionscompanyId- the primary key of the companystart- the lower bound of the range of definitionsend- the upper bound of the range of definitions (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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
-
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
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
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, throws com.liferay.portal.kernel.exception.PortalExceptionString> descriptionMap, long sourceId, String reportParameters, String fileName, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) - 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
-