com.liferay.trash.kernel.service

Class TrashEntryServiceWrapper

Object

com.liferay.trash.kernel.service.TrashEntryServiceWrapper

All Implemented Interfaces:

BaseService, ServiceWrapper<TrashEntryService>, TrashEntryService

@ProviderType
public class TrashEntryServiceWrapper
extends Object
implements TrashEntryService, ServiceWrapper<TrashEntryService>

Provides a wrapper for TrashEntryService.

Author:

Brian Wing Shun Chan

See Also:

TrashEntryService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
TrashEntryServiceWrapper(TrashEntryService trashEntryService)

Method Summary

Modifier and Type	Method and Description
void	deleteEntries(long groupId) Deletes the trash entries with the matching group ID considering permissions.
void	deleteEntries(long[] entryIds) Deletes the trash entries with the primary keys.
void	deleteEntry(long entryId) Deletes the trash entry with the primary key.
void	deleteEntry(String className, long classPK) Deletes the trash entry with the entity class name and class primary key.
TrashEntryList	getEntries(long groupId) Returns the trash entries with the matching group ID.
TrashEntryList	getEntries(long groupId, int start, int end, OrderByComparator<TrashEntry> obc) Returns a range of all the trash entries matching the group ID.
List<TrashEntry>	getEntries(long groupId, String className)
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
TrashEntryService	getWrappedService()
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.
TrashEntry	restoreEntry(long entryId)
TrashEntry	restoreEntry(long entryId, long overrideClassPK, String name) Restores the trash entry to its original location.
TrashEntry	restoreEntry(String className, long classPK)
TrashEntry	restoreEntry(String className, long classPK, long overrideClassPK, String name)
void	setWrappedService(TrashEntryService trashEntryService)

Methods inherited from class Object

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

Constructor Detail

TrashEntryServiceWrapper

public TrashEntryServiceWrapper(TrashEntryService trashEntryService)

Method Detail

deleteEntries

public void deleteEntries(long groupId)
                   throws PortalException

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

Specified by:

deleteEntries in interface TrashEntryService

Parameters:

groupId - the primary key of the group

Throws:

PortalException

deleteEntries

public void deleteEntries(long[] entryIds)
                   throws PortalException

Deletes the trash entries with the primary keys.

Specified by:

deleteEntries in interface TrashEntryService

Parameters:

entryIds - the primary keys of the trash entries

Throws:

PortalException

deleteEntry

public 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.

Specified by:

deleteEntry in interface TrashEntryService

Parameters:

entryId - the primary key of the trash entry

Throws:

PortalException

deleteEntry

public 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.

Specified by:

deleteEntry in interface TrashEntryService

Parameters:

className - the class name of the entity

classPK - the primary key of the entity

Throws:

PortalException

getEntries

public TrashEntryList getEntries(long groupId)
                          throws PrincipalException

Returns the trash entries with the matching group ID.

Specified by:

getEntries in interface TrashEntryService

Parameters:

groupId - the primary key of the group

Returns:

the matching trash entries

Throws:

PrincipalException

getEntries

public 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.

Specified by:

getEntries in interface TrashEntryService

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 List<TrashEntry> getEntries(long groupId,
                                   String className)
                            throws PrincipalException

Specified by:

getEntries in interface TrashEntryService

Throws:

PrincipalException

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface TrashEntryService

Returns:

the OSGi service identifier

moveEntry

public 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

Specified by:

moveEntry in interface TrashEntryService

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 TrashEntry restoreEntry(long entryId)
                        throws PortalException

Specified by:

restoreEntry in interface TrashEntryService

Throws:

PortalException

restoreEntry

public 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

Specified by:

restoreEntry in interface TrashEntryService

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 TrashEntry restoreEntry(String className,
                               long classPK)
                        throws PortalException

Specified by:

restoreEntry in interface TrashEntryService

Throws:

PortalException

restoreEntry

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

Specified by:

restoreEntry in interface TrashEntryService

Throws:

PortalException

getWrappedService

public TrashEntryService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<TrashEntryService>

setWrappedService

public void setWrappedService(TrashEntryService trashEntryService)

Specified by:

setWrappedService in interface ServiceWrapper<TrashEntryService>