com.liferay.content.targeting.service

Class ReportInstanceLocalServiceUtil

java.lang.Object

com.liferay.content.targeting.service.ReportInstanceLocalServiceUtil

@ProviderType
public class ReportInstanceLocalServiceUtil
extends java.lang.Object

Provides the local service utility for ReportInstance. This utility wraps com.liferay.content.targeting.service.impl.ReportInstanceLocalServiceImpl and is the primary 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:

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

Generated:

Constructor Summary

Constructors

Constructor and Description
ReportInstanceLocalServiceUtil()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportInstanceLocalServiceUtil

public ReportInstanceLocalServiceUtil()

Method Detail

addReportInstance

public static 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

public static 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

public static 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

public static 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

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

Throws:

PortalException

deleteReportInstance

public static 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:

PortalException - if a report instance with the primary key could not be found

deleteReportInstance

public static 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

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

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

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

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)

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

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

fetchReportInstance

public static ReportInstance fetchReportInstance(long reportInstanceId)

fetchReportInstance

public static ReportInstance fetchReportInstance(java.lang.String reportKey,
                                                 java.lang.String className,
                                                 long classPK)

fetchReportInstanceByUuidAndGroupId

public static 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

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

getActionableDynamicQuery

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

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 java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getReport

public static Report getReport(java.lang.String reportKey)

getReportInstance

public static 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:

PortalException - if a report instance with the primary key could not be found

getReportInstanceByUuidAndGroupId

public static 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:

PortalException - if a matching report instance could not be found

getReportInstanceCount

public static int getReportInstanceCount(java.lang.String reportKey,
                                         java.lang.String className,
                                         long classPK)

getReportInstances

public static 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

public static 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

public static java.util.List<ReportInstance> getReportInstances(java.lang.String className,
                                                                long classPK)

getReportInstances

public static java.util.List<ReportInstance> getReportInstances(java.lang.String className,
                                                                long classPK,
                                                                int start,
                                                                int end)

getReportInstances

public static java.util.List<ReportInstance> getReportInstances(java.lang.String className,
                                                                long classPK,
                                                                int start,
                                                                int end,
                                                                com.liferay.portal.kernel.util.OrderByComparator obc)

getReportInstancesByUuidAndCompanyId

public static 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

public static 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

public static int getReportInstancesCount()

Returns the number of report instances.

Returns:

the number of report instances

getReportInstancesCount

public static int getReportInstancesCount(java.lang.String className,
                                          long classPK)

searchReportInstances

public static 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

public static 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

public static 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

public static 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

public static 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

getService

public static ReportInstanceLocalService getService()