com.liferay.portlet.ratings.service
Interface RatingsEntryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

RatingsEntryLocalServiceBaseImpl, RatingsEntryLocalServiceImpl, 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.

See Also:

RatingsEntryLocalServiceUtil, RatingsEntryLocalServiceBaseImpl, RatingsEntryLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it 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)
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()
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) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
RatingsEntry	fetchEntry(long userId, String className, long classPK)
RatingsEntry	fetchRatingsEntry(long entryId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
List<RatingsEntry>	getEntries(long userId, String className, List<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)
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.
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
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)
                             throws SystemException

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

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

@Indexable(type=DELETE)
RatingsEntry 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

Returns:

the ratings entry that was removed

Throws:

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

SystemException - if a system exception occurred

deleteRatingsEntry

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

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

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

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchRatingsEntry

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

Throws:

SystemException

getRatingsEntry

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

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

SystemException - if a system exception occurred

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getRatingsEntries

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

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

Throws:

SystemException - if a system exception occurred

getRatingsEntriesCount

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

Returns the number of ratings entries.

Returns:

the number of ratings entries

Throws:

SystemException - if a system exception occurred

updateRatingsEntry

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

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

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

deleteEntry

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

Throws:

PortalException

SystemException

fetchEntry

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

Throws:

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

getEntries

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

Throws:

SystemException

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(String className,
                                                             long classPK,
                                                             double score)
                    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