|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.trash.service.TrashEntryServiceUtil
@ProviderType public class TrashEntryServiceUtil
Provides the remote service utility for TrashEntry. This utility wraps
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,
TrashEntryServiceBaseImpl,
TrashEntryServiceImpl| Constructor Summary | |
|---|---|
TrashEntryServiceUtil()
|
|
| Method Summary | |
|---|---|
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(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,
OrderByComparator<TrashEntry> obc)
Returns a range of all the trash entries matching the group ID. |
static List<TrashEntry> |
getEntries(long groupId,
String className)
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier. |
static TrashEntryService |
getService()
|
static void |
moveEntry(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,
String name)
Restores the trash entry to its original location. |
static TrashEntry |
restoreEntry(String className,
long classPK)
|
static TrashEntry |
restoreEntry(String className,
long classPK,
long overrideClassPK,
String name)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public TrashEntryServiceUtil()
| Method Detail |
|---|
public static void deleteEntries(long[] entryIds)
throws PortalException
entryIds - the primary keys of the trash entries
PortalException
public static void deleteEntries(long groupId)
throws PortalException
groupId - the primary key of the group
PortalException
public static void deleteEntry(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 entity
PortalException
public 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 entry
PortalException
public static TrashEntryList getEntries(long groupId)
throws PrincipalException
groupId - the primary key of the group
PrincipalException
public static List<TrashEntry> getEntries(long groupId,
String className)
throws PrincipalException
PrincipalException
public 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)
obc
PrincipalExceptionpublic static String getOSGiServiceIdentifier()
public static void moveEntry(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
public static TrashEntry restoreEntry(String className,
long classPK)
throws PortalException
PortalException
public static TrashEntry restoreEntry(String className,
long classPK,
long overrideClassPK,
String name)
throws PortalException
PortalException
public static TrashEntry restoreEntry(long entryId)
throws PortalException
PortalException
public static TrashEntry restoreEntry(long entryId,
long overrideClassPK,
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)
PortalExceptionpublic static TrashEntryService getService()
|
Liferay 7.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||