com.liferay.content.targeting.service

Interface ReportInstanceLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

ReportInstanceLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface ReportInstanceLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

Provides the local service interface for ReportInstance. 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:

ReportInstanceLocalServiceUtil, com.liferay.content.targeting.service.base.ReportInstanceLocalServiceBaseImpl, com.liferay.content.targeting.service.impl.ReportInstanceLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
ReportInstance	addReportInstance(long userId, java.lang.String reportKey, java.lang.String className, long classPK, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext)
ReportInstance	addReportInstance(long userId, java.lang.String reportKey, java.lang.String className, long classPK, java.lang.String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext)
ReportInstance	addReportInstance(ReportInstance reportInstance) Adds the report instance to the database.
ReportInstance	createReportInstance(long reportInstanceId) Creates a new report instance with the primary key.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
ReportInstance	deleteReportInstance(long reportInstanceId) Deletes the report instance with the primary key from the database.
ReportInstance	deleteReportInstance(ReportInstance reportInstance) Deletes the report instance from the database.
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.
ReportInstance	fetchReportInstance(long reportInstanceId)
ReportInstance	fetchReportInstance(java.lang.String reportKey, java.lang.String className, long classPK)
ReportInstance	fetchReportInstanceByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the report instance matching the UUID and group.
java.util.List<ReportInstance>	findReportInstances(java.lang.String reportKey, java.lang.String className, long classPK)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
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)
Report	getReport(java.lang.String reportKey)
ReportInstance	getReportInstance(long reportInstanceId) Returns the report instance with the primary key.
ReportInstance	getReportInstanceByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the report instance matching the UUID and group.
int	getReportInstanceCount(java.lang.String reportKey, java.lang.String className, long classPK)
java.util.List<ReportInstance>	getReportInstances(int start, int end) Returns a range of all the report instances.
java.util.List<ReportInstance>	getReportInstances(long userId, java.lang.String className, long classPK, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
java.util.List<ReportInstance>	getReportInstances(java.lang.String className, long classPK)
java.util.List<ReportInstance>	getReportInstances(java.lang.String className, long classPK, int start, int end)
java.util.List<ReportInstance>	getReportInstances(java.lang.String className, long classPK, int start, int end, com.liferay.portal.kernel.util.OrderByComparator obc)
java.util.List<ReportInstance>	getReportInstancesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the report instances matching the UUID and company.
java.util.List<ReportInstance>	getReportInstancesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<ReportInstance> orderByComparator) Returns a range of report instances matching the UUID and company.
int	getReportInstancesCount() Returns the number of report instances.
int	getReportInstancesCount(java.lang.String className, long classPK)
BaseModelSearchResult<ReportInstance>	searchReportInstances(long groupId, long userId, java.lang.String className, long classPK, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
java.util.List<ReportInstance>	searchReportInstances(long groupId, java.lang.String className, long classPK, java.lang.String keywords, int start, int end)
BaseModelSearchResult<ReportInstance>	searchReportInstances(long groupId, java.lang.String className, long classPK, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort)
ReportInstance	updateReportInstance(long reportInstanceId, long userId, java.lang.String reportKey, java.lang.String className, long classPK, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext)
ReportInstance	updateReportInstance(ReportInstance reportInstance) Updates the report instance in the database or adds it if it does not yet exist.

Method Detail

addReportInstance

@Indexable(type=REINDEX)
ReportInstance addReportInstance(long userId,
                                                          java.lang.String reportKey,
                                                          java.lang.String className,
                                                          long classPK,
                                                          java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                          java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                          java.lang.String typeSettings,
                                                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addReportInstance

@Indexable(type=REINDEX)
ReportInstance addReportInstance(long userId,
                                                          java.lang.String reportKey,
                                                          java.lang.String className,
                                                          long classPK,
                                                          java.lang.String typeSettings,
                                                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addReportInstance

@Indexable(type=REINDEX)
ReportInstance addReportInstance(ReportInstance reportInstance)

Adds the report instance to the database. Also notifies the appropriate model listeners.

Parameters:

reportInstance - the report instance

Returns:

the report instance that was added

createReportInstance

@Transactional(enabled=false)
ReportInstance createReportInstance(long reportInstanceId)

Creates a new report instance with the primary key. Does not add the report instance to the database.

Parameters:

reportInstanceId - the primary key for the new report instance

Returns:

the new report instance

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteReportInstance

@Indexable(type=DELETE)
ReportInstance deleteReportInstance(long reportInstanceId)
                                                     throws com.liferay.portal.kernel.exception.PortalException

Deletes the report instance with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

reportInstanceId - the primary key of the report instance

Returns:

the report instance that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a report instance with the primary key could not be found

deleteReportInstance

@Indexable(type=DELETE)
ReportInstance deleteReportInstance(ReportInstance reportInstance)

Deletes the report instance from the database. Also notifies the appropriate model listeners.

Parameters:

reportInstance - the report instance

Returns:

the report instance that was removed

dynamicQuery

com.liferay.portal.kernel.dao.orm.DynamicQuery 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.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

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

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.content.targeting.model.impl.ReportInstanceModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

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

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.content.targeting.model.impl.ReportInstanceModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

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

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

fetchReportInstance

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ReportInstance fetchReportInstance(long reportInstanceId)

fetchReportInstance

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ReportInstance fetchReportInstance(java.lang.String reportKey,
                                                                                                      java.lang.String className,
                                                                                                      long classPK)

fetchReportInstanceByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ReportInstance fetchReportInstanceByUuidAndGroupId(java.lang.String uuid,
                                                                                                                      long groupId)

Returns the report instance matching the UUID and group.

Parameters:

uuid - the report instance's UUID

groupId - the primary key of the group

Returns:

the matching report instance, or null if a matching report instance could not be found

findReportInstances

java.util.List<ReportInstance> findReportInstances(java.lang.String reportKey,
                                                   java.lang.String className,
                                                   long classPK)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getReport

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Report getReport(java.lang.String reportKey)

getReportInstance

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ReportInstance getReportInstance(long reportInstanceId)
                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Returns the report instance with the primary key.

Parameters:

reportInstanceId - the primary key of the report instance

Returns:

the report instance

Throws:

com.liferay.portal.kernel.exception.PortalException - if a report instance with the primary key could not be found

getReportInstanceByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ReportInstance getReportInstanceByUuidAndGroupId(java.lang.String uuid,
                                                                                                                    long groupId)
                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Returns the report instance matching the UUID and group.

Parameters:

uuid - the report instance's UUID

groupId - the primary key of the group

Returns:

the matching report instance

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching report instance could not be found

getReportInstanceCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getReportInstanceCount(java.lang.String reportKey,
                                                                                              java.lang.String className,
                                                                                              long classPK)

getReportInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ReportInstance> getReportInstances(int start,
                                                                                                                     int end)

Returns a range of all the report instances.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.content.targeting.model.impl.ReportInstanceModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of report instances

end - the upper bound of the range of report instances (not inclusive)

Returns:

the range of report instances

getReportInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ReportInstance> getReportInstances(long userId,
                                                                                                                     java.lang.String className,
                                                                                                                     long classPK,
                                                                                                                     int start,
                                                                                                                     int end,
                                                                                                                     com.liferay.portal.kernel.util.OrderByComparator obc)

getReportInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ReportInstance> getReportInstances(java.lang.String className,
                                                                                                                     long classPK)

getReportInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ReportInstance> getReportInstances(java.lang.String className,
                                                                                                                     long classPK,
                                                                                                                     int start,
                                                                                                                     int end)

getReportInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ReportInstance> getReportInstances(java.lang.String className,
                                                                                                                     long classPK,
                                                                                                                     int start,
                                                                                                                     int end,
                                                                                                                     com.liferay.portal.kernel.util.OrderByComparator obc)

getReportInstancesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ReportInstance> getReportInstancesByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                       long companyId)

Returns all the report instances matching the UUID and company.

Parameters:

uuid - the UUID of the report instances

companyId - the primary key of the company

Returns:

the matching report instances, or an empty list if no matches were found

getReportInstancesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ReportInstance> getReportInstancesByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                       long companyId,
                                                                                                                                       int start,
                                                                                                                                       int end,
                                                                                                                                       com.liferay.portal.kernel.util.OrderByComparator<ReportInstance> orderByComparator)

Returns a range of report instances matching the UUID and company.

Parameters:

uuid - the UUID of the report instances

companyId - the primary key of the company

start - the lower bound of the range of report instances

end - the upper bound of the range of report instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching report instances, or an empty list if no matches were found

getReportInstancesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getReportInstancesCount()

Returns the number of report instances.

Returns:

the number of report instances

getReportInstancesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getReportInstancesCount(java.lang.String className,
                                                                                               long classPK)

searchReportInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<ReportInstance> searchReportInstances(long groupId,
                                                                                                                               long userId,
                                                                                                                               java.lang.String className,
                                                                                                                               long classPK,
                                                                                                                               java.lang.String keywords,
                                                                                                                               int start,
                                                                                                                               int end,
                                                                                                                               com.liferay.portal.kernel.search.Sort sort)
                                                                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

searchReportInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<ReportInstance> searchReportInstances(long groupId,
                                                                                                                        java.lang.String className,
                                                                                                                        long classPK,
                                                                                                                        java.lang.String keywords,
                                                                                                                        int start,
                                                                                                                        int end)
                                                                                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

searchReportInstances

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BaseModelSearchResult<ReportInstance> searchReportInstances(long groupId,
                                                                                                                               java.lang.String className,
                                                                                                                               long classPK,
                                                                                                                               java.lang.String keywords,
                                                                                                                               int start,
                                                                                                                               int end,
                                                                                                                               com.liferay.portal.kernel.search.Sort sort)
                                                                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateReportInstance

@Indexable(type=REINDEX)
ReportInstance updateReportInstance(long reportInstanceId,
                                                             long userId,
                                                             java.lang.String reportKey,
                                                             java.lang.String className,
                                                             long classPK,
                                                             java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                                             java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                                             java.lang.String typeSettings,
                                                             com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateReportInstance

@Indexable(type=REINDEX)
ReportInstance updateReportInstance(ReportInstance reportInstance)

Updates the report instance in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

reportInstance - the report instance

Returns:

the report instance that was updated