com.liferay.trash.kernel.service

Class TrashEntryServiceUtil

Object

com.liferay.trash.kernel.service.TrashEntryServiceUtil

@ProviderType
public class TrashEntryServiceUtil
extends Object

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.

Author:

Brian Wing Shun Chan

See Also:

TrashEntryService, TrashEntryServiceBaseImpl, TrashEntryServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
TrashEntryServiceUtil()

Method Summary

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(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 Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TrashEntryServiceUtil

public TrashEntryServiceUtil()

Method Detail

deleteEntries

public static void deleteEntries(long groupId)
                          throws PortalException

Deletes the trash entries with the matching group ID considering permissions.

Parameters:

groupId - the primary key of the group

Throws:

PortalException

deleteEntries

public static void deleteEntries(long[] entryIds)
                          throws PortalException

Deletes the trash entries with the primary keys.

Parameters:

entryIds - the primary keys of the trash entries

Throws:

PortalException

deleteEntry

public static void deleteEntry(long entryId)
                        throws PortalException

Deletes the trash entry with the primary key.

This method throws a TrashPermissionException with type TrashPermissionException#DELETE if the user did not have permission to delete the trash entry.

Parameters:

entryId - the primary key of the trash entry

Throws:

PortalException

deleteEntry

public static void deleteEntry(String className,
                               long classPK)
                        throws PortalException

Deletes the trash entry with the entity class name and class primary key.

This method throws a TrashPermissionException with type TrashPermissionException#DELETE if the user did not have permission to delete the trash entry.

Parameters:

className - the class name of the entity

classPK - the primary key of the entity

Throws:

PortalException

getEntries

public static TrashEntryList getEntries(long groupId)
                                 throws PrincipalException

Returns the trash entries with the matching group ID.

Parameters:

groupId - the primary key of the group

Returns:

the matching trash entries

Throws:

PrincipalException

getEntries

public static TrashEntryList getEntries(long groupId,
                                        int start,
                                        int end,
                                        OrderByComparator<TrashEntry> obc)
                                 throws PrincipalException

Returns a range of all the trash entries matching the group ID.

Parameters:

groupId - the primary key of the group

start - the lower bound of the range of trash entries to return

end - the upper bound of the range of trash entries to return (not inclusive)

obc - the comparator to order the trash entries (optionally null)

Returns:

the range of matching trash entries ordered by comparator obc

Throws:

PrincipalException

getEntries

public static List<TrashEntry> getEntries(long groupId,
                                          String className)
                                   throws PrincipalException

Throws:

PrincipalException

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

moveEntry

public static void moveEntry(String className,
                             long classPK,
                             long destinationContainerModelId,
                             ServiceContext serviceContext)
                      throws 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 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

Parameters:

className - the class name of the entity

classPK - the primary key of the entity

destinationContainerModelId - the primary key of the new location

serviceContext - the service context to be applied (optionally null)

Throws:

PortalException

restoreEntry

public static TrashEntry restoreEntry(long entryId)
                               throws PortalException

Throws:

PortalException

restoreEntry

public static TrashEntry restoreEntry(long entryId,
                                      long overrideClassPK,
                                      String name)
                               throws 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 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

Parameters:

entryId - the primary key of the trash entry to restore

overrideClassPK - the primary key of the entity to overwrite (optionally 0)

name - a new name to give to the trash entry being restored (optionally null)

Returns:

the restored trash entry

Throws:

PortalException

restoreEntry

public static TrashEntry restoreEntry(String className,
                                      long classPK)
                               throws PortalException

Throws:

PortalException

restoreEntry

public static TrashEntry restoreEntry(String className,
                                      long classPK,
                                      long overrideClassPK,
                                      String name)
                               throws PortalException

Throws:

PortalException

getService

public static TrashEntryService getService()