com.liferay.portlet.trash.service

Class TrashEntryServiceWrapper

java.lang.Object

com.liferay.portlet.trash.service.TrashEntryServiceWrapper

All Implemented Interfaces:

BaseService, ServiceWrapper<TrashEntryService>, TrashEntryService

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

Provides a wrapper for TrashEntryService.

Author:

Brian Wing Shun Chan

See Also:

TrashEntryService

Generated:

Constructor Summary

Constructors

Constructor and Description
TrashEntryServiceWrapper(TrashEntryService trashEntryService)

Method Summary

Methods

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(java.lang.String className, long classPK) Deletes the trash entry with the entity class name and class primary key.
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
TrashEntryList	getEntries(long groupId) Returns the trash entries with the matching group ID.
TrashEntryList	getEntries(long groupId, int start, int end, OrderByComparator obc) Returns a range of all the trash entries matching the group ID.
TrashEntryService	getWrappedService()
TrashEntryService	getWrappedTrashEntryService() Deprecated. As of 6.1.0, replaced by getWrappedService()
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.
TrashEntry	restoreEntry(long entryId)
TrashEntry	restoreEntry(long entryId, long overrideClassPK, java.lang.String name) Restores the trash entry to its original location.
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setWrappedService(TrashEntryService trashEntryService)
void	setWrappedTrashEntryService(TrashEntryService trashEntryService) Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.trash.service.TrashEntryService)

Methods inherited from class java.lang.Object

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

Constructor Detail

TrashEntryServiceWrapper

public TrashEntryServiceWrapper(TrashEntryService trashEntryService)

Method Detail

getBeanIdentifier

public java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Specified by:

getBeanIdentifier in interface TrashEntryService

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Specified by:

setBeanIdentifier in interface TrashEntryService

Parameters:

beanIdentifier - the Spring bean ID for this bean

deleteEntries

public void deleteEntries(long groupId)
                   throws PortalException,
                          SystemException

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 - if a portal exception occurred

SystemException - if a system exception occurred

deleteEntries

public void deleteEntries(long[] entryIds)
                   throws PortalException,
                          SystemException

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 - 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 entries

SystemException - if a system exception occurred

deleteEntry

public void deleteEntry(long entryId)
                 throws PortalException,
                        SystemException

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 - if a trash entry with the primary key could not be found or if the user did not have permission to delete the trash entry

SystemException - if a system exception occurred

deleteEntry

public void deleteEntry(java.lang.String className,
               long classPK)
                 throws PortalException,
                        SystemException

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 - 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 entry

SystemException - if a system exception occurred

getEntries

public TrashEntryList getEntries(long groupId)
                          throws SystemException,
                                 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 - if a principal exception occurred

SystemException - if a system exception occurred

getEntries

public TrashEntryList getEntries(long groupId,
                        int start,
                        int end,
                        OrderByComparator obc)
                          throws SystemException,
                                 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 - if a system exception occurred

SystemException - if a system exception occurred

moveEntry

public void moveEntry(java.lang.String className,
             long classPK,
             long destinationContainerModelId,
             ServiceContext serviceContext)
               throws PortalException,
                      SystemException

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 - 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 occurred

SystemException - if a system exception occurred

restoreEntry

public TrashEntry restoreEntry(long entryId)
                        throws PortalException,
                               SystemException

Specified by:

restoreEntry in interface TrashEntryService

Throws:

PortalException

SystemException

restoreEntry

public TrashEntry restoreEntry(long entryId,
                      long overrideClassPK,
                      java.lang.String name)
                        throws PortalException,
                               SystemException

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 - 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 general

SystemException - if a system exception occurred

getWrappedTrashEntryService

public TrashEntryService getWrappedTrashEntryService()

Deprecated. As of 6.1.0, replaced by getWrappedService()

setWrappedTrashEntryService

public void setWrappedTrashEntryService(TrashEntryService trashEntryService)

Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.trash.service.TrashEntryService)

getWrappedService

public TrashEntryService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<TrashEntryService>

setWrappedService

public void setWrappedService(TrashEntryService trashEntryService)

Specified by:

setWrappedService in interface ServiceWrapper<TrashEntryService>