public class DefinitionLocalServiceUtil
extends java.lang.Object
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.DefinitionLocalService
Constructor and Description |
---|
DefinitionLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static Definition |
addDefinition(Definition definition)
Adds the definition to the database.
|
static Definition |
addDefinition(long userId,
long groupId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
long sourceId,
java.lang.String reportParameters,
java.lang.String fileName,
java.io.InputStream inputStream,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static Definition |
createDefinition(long definitionId)
Creates a new definition with the primary key.
|
static com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
static Definition |
deleteDefinition(Definition definition)
Deletes the definition from the database.
|
static Definition |
deleteDefinition(long definitionId)
Deletes the definition with the primary key from the database.
|
static void |
deleteDefinitions(long groupId) |
static void |
deleteDefinitionTemplates(long companyId,
java.lang.String attachmentsDirectory) |
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static <T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <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.
|
static <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.
|
static <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.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
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.
|
static Definition |
fetchDefinition(long definitionId) |
static Definition |
fetchDefinitionByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the definition matching the UUID and group.
|
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static Definition |
getDefinition(long definitionId)
Returns the definition with the primary key.
|
static Definition |
getDefinitionByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the definition matching the UUID and group.
|
static java.util.List<Definition> |
getDefinitions(int start,
int end)
Returns a range of all the definitions.
|
static java.util.List<Definition> |
getDefinitions(long groupId,
java.lang.String definitionName,
java.lang.String description,
java.lang.String sourceId,
java.lang.String reportName,
boolean andSearch,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<Definition> orderByComparator) |
static java.util.List<Definition> |
getDefinitionsByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns all the definitions matching the UUID and company.
|
static java.util.List<Definition> |
getDefinitionsByUuidAndCompanyId(java.lang.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 int |
getDefinitionsCount()
Returns the number of definitions.
|
static int |
getDefinitionsCount(long groupId,
java.lang.String definitionName,
java.lang.String description,
java.lang.String sourceId,
java.lang.String reportName,
boolean andSearch) |
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery |
getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static DefinitionLocalService |
getService() |
static Definition |
updateDefinition(Definition definition)
Updates the definition in the database or adds it if it does not yet exist.
|
static Definition |
updateDefinition(long definitionId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
long sourceId,
java.lang.String reportParameters,
java.lang.String fileName,
java.io.InputStream inputStream,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static void |
updateDefinitionResources(Definition definition,
java.lang.String[] communityPermissions,
java.lang.String[] guestPermissions) |
public static Definition addDefinition(Definition definition)
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.
definition
- the definitionpublic static Definition addDefinition(long userId, long groupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, long sourceId, java.lang.String reportParameters, java.lang.String fileName, java.io.InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static Definition createDefinition(long definitionId)
definitionId
- the primary key for the new definitionpublic static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static Definition deleteDefinition(Definition definition) throws com.liferay.portal.kernel.exception.PortalException
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.
definition
- the definitioncom.liferay.portal.kernel.exception.PortalException
public static Definition deleteDefinition(long definitionId) throws com.liferay.portal.kernel.exception.PortalException
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.
definitionId
- the primary key of the definitioncom.liferay.portal.kernel.exception.PortalException
- if a definition with the primary key could not be foundpublic static void deleteDefinitions(long groupId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void deleteDefinitionTemplates(long companyId, java.lang.String attachmentsDirectory) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <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)
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
.
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 (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static Definition fetchDefinition(long definitionId)
public static Definition fetchDefinitionByUuidAndGroupId(java.lang.String uuid, long groupId)
uuid
- the definition's UUIDgroupId
- the primary key of the groupnull
if a matching definition could not be foundpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static Definition getDefinition(long definitionId) throws com.liferay.portal.kernel.exception.PortalException
definitionId
- the primary key of the definitioncom.liferay.portal.kernel.exception.PortalException
- if a definition with the primary key could not be foundpublic static Definition getDefinitionByUuidAndGroupId(java.lang.String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the definition's UUIDgroupId
- the primary key of the groupcom.liferay.portal.kernel.exception.PortalException
- if a matching definition could not be foundpublic static java.util.List<Definition> getDefinitions(int start, int end)
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
.
start
- the lower bound of the range of definitionsend
- the upper bound of the range of definitions (not inclusive)public static java.util.List<Definition> getDefinitions(long groupId, java.lang.String definitionName, java.lang.String description, java.lang.String sourceId, java.lang.String reportName, boolean andSearch, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Definition> orderByComparator)
public static java.util.List<Definition> getDefinitionsByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the UUID of the definitionscompanyId
- the primary key of the companypublic static java.util.List<Definition> getDefinitionsByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Definition> orderByComparator)
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 (optionally null
)public static int getDefinitionsCount()
public static int getDefinitionsCount(long groupId, java.lang.String definitionName, java.lang.String description, java.lang.String sourceId, java.lang.String reportName, boolean andSearch)
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static Definition updateDefinition(Definition definition)
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.
definition
- the definitionpublic static Definition updateDefinition(long definitionId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, long sourceId, java.lang.String reportParameters, java.lang.String fileName, java.io.InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void updateDefinitionResources(Definition definition, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static DefinitionLocalService getService()