@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface DefinitionLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
DefinitionLocalServiceUtil
Modifier and Type | Method and Description |
---|---|
Definition |
addDefinition(Definition definition)
Adds the definition to the database.
|
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) |
Definition |
createDefinition(long definitionId)
Creates a new definition with the primary key.
|
com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
Definition |
deleteDefinition(Definition definition)
Deletes the definition from the database.
|
Definition |
deleteDefinition(long definitionId)
Deletes the definition with the primary key from the database.
|
void |
deleteDefinitions(long groupId) |
void |
deleteDefinitionTemplates(long companyId,
java.lang.String attachmentsDirectory) |
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 |
dynamicQuery() |
<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.
|
<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.
|
<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.
|
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.
|
Definition |
fetchDefinition(long definitionId) |
Definition |
fetchDefinitionByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the definition matching the UUID and group.
|
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
Definition |
getDefinition(long definitionId)
Returns the definition with the primary key.
|
Definition |
getDefinitionByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the definition matching the UUID and group.
|
java.util.List<Definition> |
getDefinitions(int start,
int end)
Returns a range of all the definitions.
|
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) |
java.util.List<Definition> |
getDefinitionsByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns all the definitions matching the UUID and company.
|
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.
|
int |
getDefinitionsCount()
Returns the number of definitions.
|
int |
getDefinitionsCount(long groupId,
java.lang.String definitionName,
java.lang.String description,
java.lang.String sourceId,
java.lang.String reportName,
boolean andSearch) |
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery |
getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) |
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
Definition |
updateDefinition(Definition definition)
Updates the definition in the database or adds it if it does not yet exist.
|
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) |
void |
updateDefinitionResources(Definition definition,
java.lang.String[] communityPermissions,
java.lang.String[] guestPermissions) |
@Indexable(type=REINDEX) 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 definitionDefinition 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
@Transactional(enabled=false) Definition createDefinition(long definitionId)
definitionId
- the primary key for the new definitioncom.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
createPersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=DELETE) @SystemEvent(type=1) 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
@Indexable(type=DELETE) 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 foundvoid deleteDefinitions(long groupId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
void deleteDefinitionTemplates(long companyId, java.lang.String attachmentsDirectory) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
deletePersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQuery
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQueryCount
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) <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)@Transactional(propagation=SUPPORTS, readOnly=true) <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
)@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) 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 query@Transactional(propagation=SUPPORTS, readOnly=true) Definition fetchDefinition(long definitionId)
@Transactional(propagation=SUPPORTS, readOnly=true) 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 found@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) 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 found@Transactional(propagation=SUPPORTS, readOnly=true) 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 found@Transactional(propagation=SUPPORTS, readOnly=true) 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)@Transactional(propagation=SUPPORTS, readOnly=true) 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)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Definition> getDefinitionsByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the UUID of the definitionscompanyId
- the primary key of the company@Transactional(propagation=SUPPORTS, readOnly=true) 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
)@Transactional(propagation=SUPPORTS, readOnly=true) int getDefinitionsCount()
@Transactional(propagation=SUPPORTS, readOnly=true) int getDefinitionsCount(long groupId, java.lang.String definitionName, java.lang.String description, java.lang.String sourceId, java.lang.String reportName, boolean andSearch)
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
java.lang.String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
getPersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=REINDEX) 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 definitionDefinition 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
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