com.liferay.ratings.kernel.service

Class RatingsStatsLocalServiceUtil

Object

com.liferay.ratings.kernel.service.RatingsStatsLocalServiceUtil

public class RatingsStatsLocalServiceUtil
extends Object

Provides the local service utility for RatingsStats. This utility wraps com.liferay.portlet.ratings.service.impl.RatingsStatsLocalServiceImpl 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.

Author:

Brian Wing Shun Chan

See Also:

RatingsStatsLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
RatingsStatsLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static RatingsStats	addRatingsStats(RatingsStats ratingsStats) Adds the ratings stats to the database.
static RatingsStats	addStats(long classNameId, long classPK)
static PersistedModel	createPersistedModel(Serializable primaryKeyObj)
static RatingsStats	createRatingsStats(long statsId) Creates a new ratings stats with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static RatingsStats	deleteRatingsStats(long statsId) Deletes the ratings stats with the primary key from the database.
static RatingsStats	deleteRatingsStats(RatingsStats ratingsStats) Deletes the ratings stats from the database.
static void	deleteStats(String className, long classPK)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <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.
static <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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static RatingsStats	fetchRatingsStats(long statsId)
static RatingsStats	fetchStats(String className, long classPK)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static RatingsStats	getRatingsStats(long statsId) Returns the ratings stats with the primary key.
static List<RatingsStats>	getRatingsStatses(int start, int end) Returns a range of all the ratings statses.
static int	getRatingsStatsesCount() Returns the number of ratings statses.
static RatingsStatsLocalService	getService()
static RatingsStats	getStats(long statsId)
static RatingsStats	getStats(String className, long classPK)
static Map<Long,RatingsStats>	getStats(String className, long[] classPKs)
static RatingsStats	updateRatingsStats(RatingsStats ratingsStats) Updates the ratings stats in the database or adds it if it does not yet exist.

Methods inherited from class Object

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

Constructor Detail

RatingsStatsLocalServiceUtil

public RatingsStatsLocalServiceUtil()

Method Detail

addRatingsStats

public static RatingsStats addRatingsStats(RatingsStats ratingsStats)

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

Important: Inspect RatingsStatsLocalServiceImpl 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.

Parameters:

ratingsStats - the ratings stats

Returns:

the ratings stats that was added

addStats

public static RatingsStats addStats(long classNameId,
                                    long classPK)

createPersistedModel

public static PersistedModel createPersistedModel(Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

createRatingsStats

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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteRatingsStats

public static RatingsStats deleteRatingsStats(long statsId)
                                       throws PortalException

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

Important: Inspect RatingsStatsLocalServiceImpl 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.

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

public static RatingsStats deleteRatingsStats(RatingsStats ratingsStats)

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

Important: Inspect RatingsStatsLocalServiceImpl 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.

Parameters:

ratingsStats - the ratings stats

Returns:

the ratings stats that was removed

deleteStats

public static void deleteStats(String className,
                               long classPK)

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

public static <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 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.portlet.ratings.model.impl.RatingsStatsModelImpl.

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> 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 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.portlet.ratings.model.impl.RatingsStatsModelImpl.

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

public static RatingsStats fetchRatingsStats(long statsId)

fetchStats

public static RatingsStats fetchStats(String className,
                                      long classPK)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getRatingsStats

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

public static 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 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.portlet.ratings.model.impl.RatingsStatsModelImpl.

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

public static int getRatingsStatsesCount()

Returns the number of ratings statses.

Returns:

the number of ratings statses

getStats

public static RatingsStats getStats(long statsId)
                             throws PortalException

Throws:

PortalException

getStats

public static RatingsStats getStats(String className,
                                    long classPK)
                             throws PortalException

Throws:

PortalException

getStats

public static Map<Long,RatingsStats> getStats(String className,
                                              long[] classPKs)

updateRatingsStats

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

Important: Inspect RatingsStatsLocalServiceImpl 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.

Parameters:

ratingsStats - the ratings stats

Returns:

the ratings stats that was updated

getService

public static RatingsStatsLocalService getService()