com.liferay.ratings.kernel.service

Interface RatingsEntryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

RatingsEntryLocalServiceWrapper

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

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

RatingsEntryLocalServiceUtil, RatingsEntryLocalServiceBaseImpl, RatingsEntryLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
RatingsEntry	addRatingsEntry(RatingsEntry ratingsEntry) Adds the ratings entry to the database.
RatingsEntry	createRatingsEntry(long entryId) Creates a new ratings entry with the primary key.
void	deleteEntry(long userId, String className, long classPK)
void	deleteEntry(RatingsEntry entry, long userId, String className, long classPK)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
RatingsEntry	deleteRatingsEntry(long entryId) Deletes the ratings entry with the primary key from the database.
RatingsEntry	deleteRatingsEntry(RatingsEntry ratingsEntry) Deletes the ratings entry from the database.
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.
RatingsEntry	fetchEntry(long userId, String className, long classPK)
RatingsEntry	fetchRatingsEntry(long entryId)
RatingsEntry	fetchRatingsEntryByUuidAndCompanyId(String uuid, long companyId) Returns the ratings entry with the matching UUID and company.
ActionableDynamicQuery	getActionableDynamicQuery()
List<RatingsEntry>	getEntries(long userId, String className, List<Long> classPKs) Deprecated. As of Judson (7.1.x), with no direct replacement
Map<Long,RatingsEntry>	getEntries(long userId, String className, long[] classPKs)
List<RatingsEntry>	getEntries(String className, long classPK)
List<RatingsEntry>	getEntries(String className, long classPK, double score)
int	getEntriesCount(String className, long classPK, double score)
RatingsEntry	getEntry(long userId, String className, long classPK)
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<RatingsEntry>	getRatingsEntries(int start, int end) Returns a range of all the ratings entries.
int	getRatingsEntriesCount() Returns the number of ratings entries.
RatingsEntry	getRatingsEntry(long entryId) Returns the ratings entry with the primary key.
RatingsEntry	getRatingsEntryByUuidAndCompanyId(String uuid, long companyId) Returns the ratings entry with the matching UUID and company.
RatingsEntry	updateEntry(long userId, String className, long classPK, double score, ServiceContext serviceContext)
RatingsEntry	updateRatingsEntry(RatingsEntry ratingsEntry) Updates the ratings entry in the database or adds it if it does not yet exist.

Method Detail

addRatingsEntry

@Indexable(type=REINDEX)
RatingsEntry addRatingsEntry(RatingsEntry ratingsEntry)

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

Parameters:

ratingsEntry - the ratings entry

Returns:

the ratings entry that was added

createRatingsEntry

@Transactional(enabled=false)
RatingsEntry createRatingsEntry(long entryId)

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

Parameters:

entryId - the primary key for the new ratings entry

Returns:

the new ratings entry

deleteEntry

void deleteEntry(long userId,
                 String className,
                 long classPK)
          throws PortalException

Throws:

PortalException

deleteEntry

@SystemEvent(type=1)
void deleteEntry(RatingsEntry entry,
                                      long userId,
                                      String className,
                                      long classPK)
                               throws PortalException

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteRatingsEntry

@Indexable(type=DELETE)
RatingsEntry deleteRatingsEntry(long entryId)
                                                 throws PortalException

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

Parameters:

entryId - the primary key of the ratings entry

Returns:

the ratings entry that was removed

Throws:

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

deleteRatingsEntry

@Indexable(type=DELETE)
RatingsEntry deleteRatingsEntry(RatingsEntry ratingsEntry)

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

Parameters:

ratingsEntry - the ratings entry

Returns:

the ratings entry that was removed

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

fetchEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsEntry fetchEntry(long userId,
                                                                                           String className,
                                                                                           long classPK)

fetchRatingsEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsEntry fetchRatingsEntry(long entryId)

fetchRatingsEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsEntry fetchRatingsEntryByUuidAndCompanyId(String uuid,
                                                                                                                    long companyId)

Returns the ratings entry with the matching UUID and company.

Parameters:

uuid - the ratings entry's UUID

companyId - the primary key of the company

Returns:

the matching ratings entry, or null if a matching ratings entry could not be found

getActionableDynamicQuery

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

getEntries

@Deprecated
 @Transactional(propagation=SUPPORTS,
               readOnly=true)
List<RatingsEntry> getEntries(long userId,
                                                                                                              String className,
                                                                                                              List<Long> classPKs)

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

getEntries

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

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<RatingsEntry> getEntries(String className,
                                                                                                 long classPK)

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<RatingsEntry> getEntries(String className,
                                                                                                 long classPK,
                                                                                                 double score)

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(String className,
                                                                                       long classPK,
                                                                                       double score)

getEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsEntry getEntry(long userId,
                                                                                         String className,
                                                                                         long classPK)
                                                                                  throws PortalException

Throws:

PortalException

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

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

getRatingsEntries

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

Returns a range of all the ratings entries.

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

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

Returns:

the range of ratings entries

getRatingsEntriesCount

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

Returns the number of ratings entries.

Returns:

the number of ratings entries

getRatingsEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsEntry getRatingsEntry(long entryId)
                                                                                         throws PortalException

Returns the ratings entry with the primary key.

Parameters:

entryId - the primary key of the ratings entry

Returns:

the ratings entry

Throws:

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

getRatingsEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RatingsEntry getRatingsEntryByUuidAndCompanyId(String uuid,
                                                                                                                  long companyId)
                                                                                                           throws PortalException

Returns the ratings entry with the matching UUID and company.

Parameters:

uuid - the ratings entry's UUID

companyId - the primary key of the company

Returns:

the matching ratings entry

Throws:

PortalException - if a matching ratings entry could not be found

updateEntry

RatingsEntry updateEntry(long userId,
                         String className,
                         long classPK,
                         double score,
                         ServiceContext serviceContext)
                  throws PortalException

Throws:

PortalException

updateRatingsEntry

@Indexable(type=REINDEX)
RatingsEntry updateRatingsEntry(RatingsEntry ratingsEntry)

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

Parameters:

ratingsEntry - the ratings entry

Returns:

the ratings entry that was updated