public class TrashEntryServiceUtil
extends java.lang.Object
com.liferay.trash.service.impl.TrashEntryServiceImpl
and is an
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
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 TrashEntryList |
getEntries(long groupId)
Returns the trash entries with the matching group ID.
|
static TrashEntryList |
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.
|
static java.util.List<TrashEntry> |
getEntries(long groupId,
java.lang.String className) |
static TrashEntryList |
getEntries(long groupId,
java.lang.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.
|
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static TrashEntryService |
getService() |
static void |
moveEntry(java.lang.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.
|
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) |
public static void deleteEntries(long groupId) throws com.liferay.portal.kernel.exception.PortalException
groupId
- the primary key of the groupcom.liferay.portal.kernel.exception.PortalException
public static void deleteEntries(long[] entryIds) throws com.liferay.portal.kernel.exception.PortalException
entryIds
- the primary keys of the trash entriescom.liferay.portal.kernel.exception.PortalException
public static void deleteEntry(long entryId) throws com.liferay.portal.kernel.exception.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 entrycom.liferay.portal.kernel.exception.PortalException
public static void deleteEntry(java.lang.String className, long classPK) throws com.liferay.portal.kernel.exception.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 entitycom.liferay.portal.kernel.exception.PortalException
public static TrashEntryList getEntries(long groupId) throws com.liferay.portal.kernel.security.auth.PrincipalException
groupId
- the primary key of the groupcom.liferay.portal.kernel.security.auth.PrincipalException
public static TrashEntryList getEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) throws com.liferay.portal.kernel.security.auth.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)orderByComparator
- the comparator to order the trash entries
(optionally null
)orderByComparator
com.liferay.portal.kernel.security.auth.PrincipalException
public static java.util.List<TrashEntry> getEntries(long groupId, java.lang.String className) throws com.liferay.portal.kernel.security.auth.PrincipalException
com.liferay.portal.kernel.security.auth.PrincipalException
public static TrashEntryList getEntries(long groupId, java.lang.String className, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<TrashEntry> orderByComparator) throws com.liferay.portal.kernel.security.auth.PrincipalException
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
(optionally null
)orderByComparator
com.liferay.portal.kernel.security.auth.PrincipalException
public static java.lang.String getOSGiServiceIdentifier()
public static void moveEntry(java.lang.String className, long classPK, long destinationContainerModelId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.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
)com.liferay.portal.kernel.exception.PortalException
public static TrashEntry restoreEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static TrashEntry restoreEntry(long entryId, long overrideClassPK, java.lang.String name) throws com.liferay.portal.kernel.exception.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
)com.liferay.portal.kernel.exception.PortalException
public static TrashEntry restoreEntry(java.lang.String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static TrashEntry restoreEntry(java.lang.String className, long classPK, long overrideClassPK, java.lang.String name) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static TrashEntryService getService()