@ProviderType
public class TrashEntryServiceUtil
extends java.lang.Object
com.liferay.portlet.trash.service.impl.TrashEntryServiceImpl and is the
primary access point for service operations in application layer code running
on a remote server. Methods of this service are expected to have security
checks based on the propagated JAAS credentials because this service can be
accessed remotely.TrashEntryService,
com.liferay.portlet.trash.service.base.TrashEntryServiceBaseImpl,
com.liferay.portlet.trash.service.impl.TrashEntryServiceImpl| Constructor and Description |
|---|
TrashEntryServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static void |
deleteEntries(long groupId)
Deletes the trash entries with the matching group ID considering
permissions.
|
static void |
deleteEntries(long[] entryIds)
Deletes the trash entries with the primary keys.
|
static void |
deleteEntry(long entryId)
Deletes the trash entry with the primary key.
|
static void |
deleteEntry(java.lang.String className,
long classPK)
Deletes the trash entry with the entity class name and class primary key.
|
static java.lang.String |
getBeanIdentifier()
Returns the Spring bean ID for this bean.
|
static TrashEntryList |
getEntries(long groupId)
Returns the trash entries with the matching group ID.
|
static TrashEntryList |
getEntries(long groupId,
int start,
int end,
OrderByComparator<TrashEntry> obc)
Returns a range of all the trash entries matching the group ID.
|
static java.util.List<TrashEntry> |
getEntries(long groupId,
java.lang.String className) |
static TrashEntryService |
getService() |
static void |
moveEntry(java.lang.String className,
long classPK,
long destinationContainerModelId,
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.
|
static TrashEntry |
restoreEntry(long entryId) |
static TrashEntry |
restoreEntry(long entryId,
long overrideClassPK,
java.lang.String name)
Restores the trash entry to its original location.
|
static TrashEntry |
restoreEntry(java.lang.String className,
long classPK) |
static TrashEntry |
restoreEntry(java.lang.String className,
long classPK,
long overrideClassPK,
java.lang.String name) |
static void |
setBeanIdentifier(java.lang.String beanIdentifier)
Sets the Spring bean ID for this bean.
|
void |
setService(TrashEntryService service)
Deprecated.
As of 6.2.0
|
public static void deleteEntries(long[] entryIds)
throws PortalException
entryIds - the primary keys of the trash entriesPortalException - if a trash entry with the primary key could not
be found or if the user did not have permission to delete any one
of the trash entriespublic static void deleteEntries(long groupId)
throws PortalException
groupId - the primary key of the groupPortalException - if a portal exception occurredpublic static void deleteEntry(java.lang.String className,
long classPK)
throws PortalException
This method throws a TrashPermissionException with type TrashPermissionException#DELETE if the user did not have permission to
delete the trash entry.
className - the class name of the entityclassPK - the primary key of the entityPortalException - if a trash entry with the entity class name and
primary key could not be found or if the user did not have
permission to delete the entrypublic static void deleteEntry(long entryId)
throws PortalException
This method throws a TrashPermissionException with type TrashPermissionException#DELETE if the user did not have permission to
delete the trash entry.
entryId - the primary key of the trash entryPortalException - if a trash entry with the primary key could not
be found or if the user did not have permission to delete the
trash entrypublic static java.lang.String getBeanIdentifier()
public static TrashEntryList getEntries(long groupId) throws PrincipalException
groupId - the primary key of the groupPrincipalException - if a principal exception occurredpublic static java.util.List<TrashEntry> getEntries(long groupId, java.lang.String className) throws PrincipalException
PrincipalExceptionpublic static TrashEntryList getEntries(long groupId, int start, int end, OrderByComparator<TrashEntry> obc) throws PrincipalException
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)obc - the comparator to order the trash entries (optionally
null)obcPrincipalException - if a system exception occurredpublic static void moveEntry(java.lang.String className,
long classPK,
long destinationContainerModelId,
ServiceContext serviceContext)
throws PortalException
This method throws a TrashPermissionException if 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
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 (optionally
null)PortalException - if a matching trash entry could not be found, if
the user did not have permission to move the trash entry to the
new location, if the user did not have permission to restore the
trash entry, if a duplicate trash entry exists at the new
location, or if a portal exception occurredpublic static TrashEntry restoreEntry(java.lang.String className, long classPK) throws PortalException
PortalExceptionpublic static TrashEntry restoreEntry(java.lang.String className, long classPK, long overrideClassPK, java.lang.String name) throws PortalException
PortalExceptionpublic static TrashEntry restoreEntry(long entryId) throws PortalException
PortalExceptionpublic static TrashEntry restoreEntry(long entryId, long overrideClassPK, java.lang.String name) throws PortalException
This method throws a TrashPermissionException if 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
entryId - the primary key of the trash entry to restoreoverrideClassPK - the primary key of the entity to overwrite
(optionally 0)name - a new name to give to the trash entry being restored
(optionally null)PortalException - if a matching trash entry could not be found, if
the user did not have permission to overwrite an existing trash
entry, to rename the trash entry being restored, or to restore
the trash entry in generalpublic static void setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanpublic static TrashEntryService getService()
@Deprecated public void setService(TrashEntryService service)