Interface TrashEntryLocalService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.change.tracking.CTService<TrashEntry>,com.liferay.portal.kernel.service.PersistedModelLocalService
- All Known Implementing Classes:
TrashEntryLocalServiceWrapper
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddTrashEntry(long userId, long groupId, String className, long classPK, String classUuid, String referrerClassName, int status, List<com.liferay.portal.kernel.util.ObjectValuePair<Long, Integer>> statusOVPs, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties) Moves an entry to trash.addTrashEntry(TrashEntry trashEntry) Adds the trash entry to the database.voidcom.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) createTrashEntry(long entryId) Creates a new trash entry with the primary key.voiddeleteEntries(long groupId) voiddeleteEntries(long groupId, boolean deleteTrashedModels) deleteEntry(long entryId) Deletes the trash entry with the primary key.deleteEntry(TrashEntry trashEntry) deleteEntry(String className, long classPK) Deletes the trash entry with the entity class name and primary key.com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) deleteTrashEntry(long entryId) Deletes the trash entry with the primary key from the database.deleteTrashEntry(TrashEntry trashEntry) Deletes the trash entry from the database.<T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.fetchEntry(long entryId) Returns the trash entry with the primary key.fetchEntry(String className, long classPK) Returns the trash entry with the entity class name and primary key.fetchTrashEntry(long entryId) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerycom.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<TrashEntry>getEntries(long groupId) Returns the trash entries with the matching group ID.getEntries(long groupId, int start, int end) Returns a range of all the trash entries matching the group ID.getEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) Returns a range of all the trash entries matching the group ID.getEntries(long groupId, String className) intgetEntriesCount(long groupId) Returns the number of trash entries with the group ID.getEntry(long entryId) Returns the trash entry with the primary key.Returns the entry with the entity class name and primary key.com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQueryReturns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) getTrashEntries(int start, int end) Returns a range of all the trash entries.intReturns the number of trash entries.getTrashEntry(long entryId) Returns the trash entry with the primary key.com.liferay.portal.kernel.search.Hitssearch(long companyId, long groupId, long userId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) com.liferay.portal.kernel.search.BaseModelSearchResult<TrashEntry>searchTrashEntries(long companyId, long groupId, long userId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) updateTrashEntry(TrashEntry trashEntry) Updates the trash entry in the database or adds it if it does not yet exist.<R,E extends Throwable>
RupdateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<TrashEntry>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addTrashEntry
TrashEntry addTrashEntry(long userId, long groupId, String className, long classPK, String classUuid, String referrerClassName, int status, List<com.liferay.portal.kernel.util.ObjectValuePair<Long, Integer>> statusOVPs, com.liferay.portal.kernel.util.UnicodeProperties typeSettingsUnicodeProperties) throws com.liferay.portal.kernel.exception.PortalExceptionMoves an entry to trash.- Parameters:
userId- the primary key of the user removing the entitygroupId- the primary key of the entry's groupclassName- the class name of the entityclassPK- the primary key of the entityclassUuid- the UUID of the entity's classreferrerClassName- the referrer class name used to add a deletionSystemEventstatus- the status of the entity prior to being moved to trashstatusOVPs- the primary keys and statuses of any of the entry's versions (e.g.,com.liferay.portlet.documentlibrary.model.DLFileVersion)typeSettingsUnicodeProperties- the type settings properties- Returns:
- the trashEntry
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addTrashEntry
Adds the trash entry to the database. Also notifies the appropriate model listeners.Important: Inspect TrashEntryLocalServiceImpl 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:
trashEntry- the trash entry- Returns:
- the trash entry that was added
-
checkEntries
void checkEntries() throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-
createPersistedModel
com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
createTrashEntry
Creates a new trash entry with the primary key. Does not add the trash entry to the database.- Parameters:
entryId- the primary key for the new trash entry- Returns:
- the new trash entry
-
deleteEntries
void deleteEntries(long groupId) -
deleteEntries
void deleteEntries(long groupId, boolean deleteTrashedModels) -
deleteEntry
Deletes the trash entry with the primary key.- Parameters:
entryId- the primary key of the trash entry- Returns:
- the trash entry with the primary key
-
deleteEntry
Deletes the trash entry with the entity class name and primary key.- Parameters:
className- the class name of entityclassPK- the primary key of the entry- Returns:
- the trash entry with the entity class name and primary key
-
deleteEntry
-
deletePersistedModel
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteTrashEntry
@Indexable(type=DELETE) TrashEntry deleteTrashEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException Deletes the trash entry with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect TrashEntryLocalServiceImpl 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 trash entry- Returns:
- the trash entry that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a trash entry with the primary key could not be found
-
deleteTrashEntry
Deletes the trash entry from the database. Also notifies the appropriate model listeners.Important: Inspect TrashEntryLocalServiceImpl 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:
trashEntry- the trash entry- Returns:
- the trash entry that was removed
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() -
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.trash.model.impl.TrashEntryModelImpl.- 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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.trash.model.impl.TrashEntryModelImpl.- 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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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
Returns the trash entry with the primary key.- Parameters:
entryId- the primary key of the entry- Returns:
- the trash entry with the primary key
-
fetchEntry
@Transactional(propagation=SUPPORTS, readOnly=true) TrashEntry fetchEntry(String className, long classPK) Returns the trash entry with the entity class name and primary key.- Parameters:
className- the class name of the entityclassPK- the primary key of the entity- Returns:
- the trash entry with the entity class name and primary key
-
fetchTrashEntry
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() -
getEntries
Returns the trash entries with the matching group ID.- Parameters:
groupId- the primary key of the group- Returns:
- the trash entries with the group ID
-
getEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<TrashEntry> getEntries(long groupId, int start, int end) Returns a range of all the trash entries matching the group ID.- Parameters:
groupId- the primary key of the groupstart- the lower bound of the range of trash entries to returnend- the upper bound of the range of trash entries to return (not inclusive)- Returns:
- the range of matching trash entries
-
getEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<TrashEntry> getEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) Returns a range of all the trash entries matching the group ID.- Parameters:
groupId- the primary key of the groupstart- the lower bound of the range of trash entries to returnend- the upper bound of the range of trash entries to return (not inclusive)orderByComparator- the comparator to order the trash entries (optionallynull)- Returns:
- the range of matching trash entries ordered by comparator
orderByComparator
-
getEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<TrashEntry> getEntries(long groupId, String className) -
getEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getEntriesCount(long groupId) Returns the number of trash entries with the group ID.- Parameters:
groupId- the primary key of the group- Returns:
- the number of matching trash entries
-
getEntry
@Transactional(propagation=SUPPORTS, readOnly=true) TrashEntry getEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException Returns the trash entry with the primary key.- Parameters:
entryId- the primary key of the trash entry- Returns:
- the trash entry with the primary key
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getEntry
@Transactional(propagation=SUPPORTS, readOnly=true) TrashEntry getEntry(String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Returns the entry with the entity class name and primary key.- Parameters:
className- the class name of the entityclassPK- the primary key of the entity- Returns:
- the trash entry with the entity class name and primary key
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getTrashEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<TrashEntry> getTrashEntries(int start, int end) Returns a range of all the trash entries.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.trash.model.impl.TrashEntryModelImpl.- Parameters:
start- the lower bound of the range of trash entriesend- the upper bound of the range of trash entries (not inclusive)- Returns:
- the range of trash entries
-
getTrashEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getTrashEntriesCount()Returns the number of trash entries.- Returns:
- the number of trash entries
-
getTrashEntry
@Transactional(propagation=SUPPORTS, readOnly=true) TrashEntry getTrashEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException Returns the trash entry with the primary key.- Parameters:
entryId- the primary key of the trash entry- Returns:
- the trash entry
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a trash entry with the primary key could not be found
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.search.Hits search(long companyId, long groupId, long userId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) -
searchTrashEntries
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.search.BaseModelSearchResult<TrashEntry> searchTrashEntries(long companyId, long groupId, long userId, String keywords, int start, int end, com.liferay.portal.kernel.search.Sort sort) -
updateTrashEntry
Updates the trash entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect TrashEntryLocalServiceImpl 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:
trashEntry- the trash entry- Returns:
- the trash entry that was updated
-
getCTPersistence
@Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<TrashEntry> getCTPersistence()- Specified by:
getCTPersistencein interfacecom.liferay.portal.kernel.service.change.tracking.CTService<TrashEntry>
-
getModelClass
- Specified by:
getModelClassin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<TrashEntry>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<TrashEntry>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<TrashEntry>- Throws:
E extends Throwable
-