com.liferay.portlet.ratings.service
Interface RatingsEntryLocalService

All Known Implementing Classes:

RatingsEntryLocalServiceBaseImpl, RatingsEntryLocalServiceImpl, RatingsEntryLocalServiceWrapper

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

The interface for the ratings entry local service.

Never modify or reference this interface directly. Always use RatingsEntryLocalServiceUtil to access the ratings entry local service. Add custom service methods to RatingsEntryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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:

RatingsEntryLocalServiceUtil, RatingsEntryLocalServiceBaseImpl, RatingsEntryLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

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	deleteRatingsEntry(long entryId) Deletes the ratings entry with the primary key from the database.
void	deleteRatingsEntry(RatingsEntry ratingsEntry) Deletes the ratings entry from the database.
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
List<RatingsEntry>	getEntries(long userId, String className, List<Long> classPKs)
List<RatingsEntry>	getEntries(String className, long classPK)
RatingsEntry	getEntry(long userId, String className, long classPK)
List<RatingsEntry>	getRatingsEntries(int start, int end) Gets a range of all the ratings entries.
int	getRatingsEntriesCount() Gets the number of ratings entries.
RatingsEntry	getRatingsEntry(long entryId) Gets the ratings entry with the primary key.
RatingsEntry	updateEntry(long userId, String className, long classPK, double score, ServiceContext serviceContext)
RatingsEntry	updateRatingsEntry(RatingsEntry ratingsEntry) Updates the ratings entry in the database.
RatingsEntry	updateRatingsEntry(RatingsEntry ratingsEntry, boolean merge) Updates the ratings entry in the database.

Method Detail

addRatingsEntry

RatingsEntry addRatingsEntry(RatingsEntry ratingsEntry)
                             throws SystemException

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

Parameters:

ratingsEntry - the ratings entry to add

Returns:

the ratings entry that was added

Throws:

SystemException - if a system exception occurred

createRatingsEntry

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

deleteRatingsEntry

void deleteRatingsEntry(long entryId)
                        throws PortalException,
                               SystemException

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 to delete

Throws:

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

SystemException - if a system exception occurred

deleteRatingsEntry

void deleteRatingsEntry(RatingsEntry ratingsEntry)
                        throws SystemException

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

Parameters:

ratingsEntry - the ratings entry to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

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.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getRatingsEntry

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

Gets the ratings entry with the primary key.

Parameters:

entryId - the primary key of the ratings entry to get

Returns:

the ratings entry

Throws:

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

SystemException - if a system exception occurred

getRatingsEntries

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

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

Parameters:

start - the lower bound of the range of ratings entries to return

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

Returns:

the range of ratings entries

Throws:

SystemException - if a system exception occurred

getRatingsEntriesCount

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

Gets the number of ratings entries.

Returns:

the number of ratings entries

Throws:

SystemException - if a system exception occurred

updateRatingsEntry

RatingsEntry updateRatingsEntry(RatingsEntry ratingsEntry)
                                throws SystemException

Updates the ratings entry in the database. Also notifies the appropriate model listeners.

Parameters:

ratingsEntry - the ratings entry to update

Returns:

the ratings entry that was updated

Throws:

SystemException - if a system exception occurred

updateRatingsEntry

RatingsEntry updateRatingsEntry(RatingsEntry ratingsEntry,
                                boolean merge)
                                throws SystemException

Updates the ratings entry in the database. Also notifies the appropriate model listeners.

Parameters:

ratingsEntry - the ratings entry to update

merge - whether to merge the ratings entry with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the ratings entry that was updated

Throws:

SystemException - if a system exception occurred

deleteEntry

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

Throws:

PortalException

SystemException

getEntries

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

Throws:

SystemException

getEntries

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

Throws:

SystemException

getEntry

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

Throws:

PortalException

SystemException

updateEntry

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

Throws:

PortalException

SystemException