Package com.liferay.trash.service
Interface TrashEntryService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseService
- All Known Implementing Classes:
TrashEntryServiceWrapper
@AccessControlled
@CTAware
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface TrashEntryService
extends com.liferay.portal.kernel.service.BaseService
Provides the remote service interface for TrashEntry. Methods of this
service are expected to have security checks based on the propagated JAAS
credentials because this service can be accessed remotely.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionvoiddeleteEntries(long groupId) Deletes the trash entries with the matching group ID considering permissions.voiddeleteEntries(long[] entryIds) Deletes the trash entries with the primary keys.voiddeleteEntry(long entryId) Deletes the trash entry with the primary key.voiddeleteEntry(String className, long classPK) Deletes the trash entry with the entity class name and class primary key.getEntries(long groupId) Returns the trash entries with the matching 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) getEntries(long groupId, String className, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) Returns a range of all the trash entries matching the group ID.Returns the OSGi service identifier.voidmoveEntry(String className, long classPK, long destinationContainerModelId, com.liferay.portal.kernel.service.ServiceContext serviceContext) Moves the trash entry with the entity class name and primary key, restoring it to a new location identified by the destination container model ID.restoreEntry(long entryId) restoreEntry(long entryId, long overrideClassPK, String name) Restores the trash entry to its original location.restoreEntry(String className, long classPK) restoreEntry(String className, long classPK, long overrideClassPK, String name)
-
Method Details
-
deleteEntries
@Transactional(noRollbackFor=com.liferay.portal.kernel.exception.TrashPermissionException.class) void deleteEntries(long groupId) throws com.liferay.portal.kernel.exception.PortalException Deletes the trash entries with the matching group ID considering permissions.- Parameters:
groupId- the primary key of the group- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteEntries
@Transactional(noRollbackFor=com.liferay.portal.kernel.exception.TrashPermissionException.class) void deleteEntries(long[] entryIds) throws com.liferay.portal.kernel.exception.PortalException Deletes the trash entries with the primary keys.- Parameters:
entryIds- the primary keys of the trash entries- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteEntry
void deleteEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException Deletes the trash entry with the primary key.This method throws a
TrashPermissionExceptionwith typeTrashPermissionException.DELETEif the user did not have permission to delete the trash entry.- Parameters:
entryId- the primary key of the trash entry- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteEntry
void deleteEntry(String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException Deletes the trash entry with the entity class name and class primary key.This method throws a
TrashPermissionExceptionwith typeTrashPermissionException.DELETEif the user did not have permission to delete the trash entry.- Parameters:
className- the class name of the entityclassPK- the primary key of the entity- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getEntries
@Transactional(propagation=SUPPORTS, readOnly=true) TrashEntryList getEntries(long groupId) throws com.liferay.portal.kernel.security.auth.PrincipalException Returns the trash entries with the matching group ID.- Parameters:
groupId- the primary key of the group- Returns:
- the matching trash entries
- Throws:
com.liferay.portal.kernel.security.auth.PrincipalException
-
getEntries
@Transactional(propagation=SUPPORTS, readOnly=true) TrashEntryList getEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) throws com.liferay.portal.kernel.security.auth.PrincipalException 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 - Throws:
com.liferay.portal.kernel.security.auth.PrincipalException
-
getEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<TrashEntry> getEntries(long groupId, String className) throws com.liferay.portal.kernel.security.auth.PrincipalException - Throws:
com.liferay.portal.kernel.security.auth.PrincipalException
-
getEntries
@Transactional(propagation=SUPPORTS, readOnly=true) TrashEntryList getEntries(long groupId, String className, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) throws com.liferay.portal.kernel.security.auth.PrincipalException Returns a range of all the trash entries matching the group ID.- Parameters:
groupId- the primary key of the groupclassName- the class name of the entitystart- 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 - Throws:
com.liferay.portal.kernel.security.auth.PrincipalException
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
moveEntry
void moveEntry(String className, long classPK, long destinationContainerModelId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException Moves the trash entry with the entity class name and primary key, restoring it to a new location identified by the destination container model ID.This method throws a
TrashPermissionExceptionif the user did not have the permission to perform one of the necessary operations. The exception is created with a type specific to the operation:-
TrashPermissionException.MOVE- if the user did not have permission to move the trash entry to the new destination -
TrashPermissionException.RESTORE- if the user did not have permission to restore the trash entry
- Parameters:
className- the class name of the entityclassPK- the primary key of the entitydestinationContainerModelId- the primary key of the new locationserviceContext- the service context to be applied (optionallynull)- Throws:
com.liferay.portal.kernel.exception.PortalException
-
-
restoreEntry
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
restoreEntry
TrashEntry restoreEntry(long entryId, long overrideClassPK, String name) throws com.liferay.portal.kernel.exception.PortalException Restores the trash entry to its original location. In order to handle a duplicate trash entry already existing at the original location, either pass in the primary key of the existing trash entry's entity to overwrite or pass in a new name to give to the trash entry being restored.This method throws a
TrashPermissionExceptionif the user did not have the permission to perform one of the necessary operations. The exception is created with a type specific to the operation:-
TrashPermissionException.RESTORE- if the user did not have permission to restore the trash entry -
TrashPermissionException.RESTORE_OVERWRITE- if the user did not have permission to delete the existing trash entry -
TrashPermissionException.RESTORE_RENAME- if the user did not have permission to rename the trash entry
- Parameters:
entryId- the primary key of the trash entry to restoreoverrideClassPK- the primary key of the entity to overwrite (optionally0)name- a new name to give to the trash entry being restored (optionallynull)- Returns:
- the restored trash entry
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
-
restoreEntry
TrashEntry restoreEntry(String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
restoreEntry
TrashEntry restoreEntry(String className, long classPK, long overrideClassPK, String name) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-