Interface RatingsEntryLocalService
- All Superinterfaces:
BaseLocalService
,CTService<RatingsEntry>
,PersistedModelLocalService
- All Known Implementing Classes:
RatingsEntryLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddRatingsEntry
(RatingsEntry ratingsEntry) Adds the ratings entry to the database.createPersistedModel
(Serializable primaryKeyObj) 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) deletePersistedModel
(PersistedModel persistedModel) deleteRatingsEntry
(long entryId) Deletes the ratings entry with the primary key from the database.deleteRatingsEntry
(RatingsEntry ratingsEntry) Deletes the ratings entry from the database.<T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchEntry
(long userId, String className, long classPK) fetchRatingsEntry
(long entryId) fetchRatingsEntryByUuidAndCompanyId
(String uuid, long companyId) Returns the ratings entry with the matching UUID and company.getEntries
(long userId, String className, long[] classPKs) getEntries
(String className, long classPK) getEntries
(String className, long classPK, double score) int
getEntriesCount
(String className, long classPK, double score) getExportActionableDynamicQuery
(PortletDataContext portletDataContext) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getRatingsEntries
(int start, int end) Returns a range of all the ratings entries.int
Returns the number of ratings entries.getRatingsEntry
(long entryId) Returns the ratings entry with the primary key.getRatingsEntryByUuidAndCompanyId
(String uuid, long companyId) Returns the ratings entry with the matching UUID and company.updateEntry
(long userId, String className, long classPK, double score, ServiceContext serviceContext) updateRatingsEntry
(RatingsEntry ratingsEntry) Updates the ratings entry in the database or adds it if it does not yet exist.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<RatingsEntry>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addRatingsEntry
Adds the ratings entry to the database. Also notifies the appropriate model listeners.Important: Inspect RatingsEntryLocalServiceImpl 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:
ratingsEntry
- the ratings entry- Returns:
- the ratings entry that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createRatingsEntry
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
- Throws:
PortalException
-
deleteEntry
@SystemEvent(type=1) void deleteEntry(RatingsEntry entry, long userId, String className, long classPK) throws PortalException - Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteRatingsEntry
Deletes the ratings entry with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect RatingsEntryLocalServiceImpl 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:
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
Deletes the ratings entry from the database. Also notifies the appropriate model listeners.Important: Inspect RatingsEntryLocalServiceImpl 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:
ratingsEntry
- the ratings entry- Returns:
- the ratings entry that was removed
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.ratings.model.impl.RatingsEntryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.ratings.model.impl.RatingsEntryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- 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
-
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 UUIDcompanyId
- 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
@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 interfacePersistedModelLocalService
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.ratings.model.impl.RatingsEntryModelImpl
.- Parameters:
start
- the lower bound of the range of ratings entriesend
- the upper bound of the range of ratings entries (not inclusive)- Returns:
- the range of ratings entries
-
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 UUIDcompanyId
- 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
Updates the ratings entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect RatingsEntryLocalServiceImpl 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:
ratingsEntry
- the ratings entry- Returns:
- the ratings entry that was updated
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<RatingsEntry>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<RatingsEntry>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<RatingsEntry>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<RatingsEntry>
- Throws:
E extends Throwable
-