com.liferay.ratings.kernel.service

Interface RatingsStatsLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

RatingsStatsLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface RatingsStatsLocalService
extends BaseLocalService, PersistedModelLocalService

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

Author:

Brian Wing Shun Chan

See Also:

RatingsStatsLocalServiceUtil, RatingsStatsLocalServiceBaseImpl, RatingsStatsLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
RatingsStats	addRatingsStats(RatingsStats ratingsStats) Adds the ratings stats to the database.
RatingsStats	addStats(long classNameId, long classPK)
RatingsStats	createRatingsStats(long statsId) Creates a new ratings stats with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
RatingsStats	deleteRatingsStats(long statsId) Deletes the ratings stats with the primary key from the database.
RatingsStats	deleteRatingsStats(RatingsStats ratingsStats) Deletes the ratings stats from the database.
void	deleteStats(String className, long classPK)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
RatingsStats	fetchRatingsStats(long statsId)
RatingsStats	fetchStats(String className, long classPK)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
RatingsStats	getRatingsStats(long statsId) Returns the ratings stats with the primary key.
List<RatingsStats>	getRatingsStatses(int start, int end) Returns a range of all the ratings statses.
int	getRatingsStatsesCount() Returns the number of ratings statses.
RatingsStats	getStats(long statsId)
List<RatingsStats>	getStats(String className, List<Long> classPKs) Deprecated. As of Judson (7.1.x), with no direct replacement
RatingsStats	getStats(String className, long classPK)
Map<Long,RatingsStats>	getStats(String className, long[] classPKs)
RatingsStats	updateRatingsStats(RatingsStats ratingsStats) Updates the ratings stats in the database or adds it if it does not yet exist.

Method Detail

addRatingsStats

@Indexable(type=REINDEX)
RatingsStats addRatingsStats(RatingsStats ratingsStats)

Adds the ratings stats to the database. Also notifies the appropriate model listeners.

Parameters:

ratingsStats - the ratings stats

Returns:

the ratings stats that was added

addStats

RatingsStats addStats(long classNameId,
                      long classPK)

createRatingsStats

@Transactional(enabled=false)
RatingsStats createRatingsStats(long statsId)

Creates a new ratings stats with the primary key. Does not add the ratings stats to the database.

Parameters:

statsId - the primary key for the new ratings stats

Returns:

the new ratings stats

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteRatingsStats

@Indexable(type=DELETE)
RatingsStats deleteRatingsStats(long statsId)
                                                 throws PortalException

Deletes the ratings stats with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

statsId - the primary key of the ratings stats

Returns:

the ratings stats that was removed

Throws:

PortalException - if a ratings stats with the primary key could not be found

deleteRatingsStats

@Indexable(type=DELETE)
RatingsStats deleteRatingsStats(RatingsStats ratingsStats)

Deletes the ratings stats from the database. Also notifies the appropriate model listeners.

Parameters:

ratingsStats - the ratings stats

Returns:

the ratings stats that was removed

deleteStats

void deleteStats(String className,
                 long classPK)

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> 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

<T> List<T> dynamicQuery(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 RatingsStatsModelImpl. 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> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         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 RatingsStatsModelImpl. 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(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(DynamicQuery dynamicQuery,
                       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

fetchRatingsStats

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsStats fetchRatingsStats(long statsId)

fetchStats

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsStats fetchStats(String className,
                                                                                           long classPK)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getRatingsStats

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsStats getRatingsStats(long statsId)
                                                                                         throws PortalException

Returns the ratings stats with the primary key.

Parameters:

statsId - the primary key of the ratings stats

Returns:

the ratings stats

Throws:

PortalException - if a ratings stats with the primary key could not be found

getRatingsStatses

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<RatingsStats> getRatingsStatses(int start,
                                                                                                        int end)

Returns a range of all the ratings statses.

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 RatingsStatsModelImpl. 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 ratings statses

end - the upper bound of the range of ratings statses (not inclusive)

Returns:

the range of ratings statses

getRatingsStatsesCount

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

Returns the number of ratings statses.

Returns:

the number of ratings statses

getStats

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsStats getStats(long statsId)
                                                                                  throws PortalException

Throws:

PortalException

getStats

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<RatingsStats> getStats(String className,
                                                                                                            List<Long> classPKs)

Deprecated. As of Judson (7.1.x), with no direct replacement

getStats

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsStats getStats(String className,
                                                                                         long classPK)
                                                                                  throws PortalException

Throws:

PortalException

getStats

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Map<Long,RatingsStats> getStats(String className,
                                                                                                   long[] classPKs)

updateRatingsStats

@Indexable(type=REINDEX)
RatingsStats updateRatingsStats(RatingsStats ratingsStats)

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

Parameters:

ratingsStats - the ratings stats

Returns:

the ratings stats that was updated