com.liferay.portal.kernel.trash

Interface TrashHandler

All Known Implementing Classes:

BaseTrashHandler

@ProviderType
public interface TrashHandler

The interface for managing the basic trash operations of the Recycle Bin, which include:

• Deleting trash entries
• Moving trash entries out of the Recycle Bin to new destinations
• Restoring trash entries to their original locations

These operations are supported for the following entities via their respective trash handlers:

• BlogsEntry via com.liferay.portlet.blogs.trash.BlogsEntryTrashHandler
• BookmarksEntry via com.liferay.bookmarks.trash.BookmarksEntryTrashHandler located in Liferay Portal's external modules directory.
• DLFileEntry via com.liferay.portlet.documentlibrary.trash.DLFileEntryTrashHandler
• DLFileShortcut via com.liferay.portlet.documentlibrary.trash.DLFileShortcutTrashHandler
• DLFolder via com.liferay.portlet.documentlibrary.trash.DLFolderTrashHandler
• MBThread via com.liferay.message.boards.trash.MBThreadTrashHandler located in Liferay Portal's external modules directory.
• WikiNode via com.liferay.wiki.trash.WikiNodeTrashHandler located in Liferay Portal's external modules directory.
• WikiPage via com.liferay.wiki.trash.WikiPageTrashHandler located in Liferay Portal's external modules directory.

Author:

Alexander Chow, Zsolt Berentey

Method Summary

Modifier and Type	Method and Description
SystemEvent	addDeletionSystemEvent(long userId, long groupId, long classPK, String classUuid, String referrerClassName)
void	checkDuplicateEntry(long classPK, long containerModelId, String newName) Deprecated. As of Wilberforce (7.0.x), replaced by checkRestorableEntry(long, long, String)
void	checkDuplicateTrashEntry(TrashEntry trashEntry, long containerModelId, String newName) Deprecated. As of Wilberforce (7.0.x), replaced by checkRestorableEntry(TrashEntry, long, String)
void	checkRestorableEntry(long classPK, long containerModelId, String newName)
void	checkRestorableEntry(TrashEntry trashEntry, long containerModelId, String newName) Checks if a duplicate trash entry already exists in the destination container.
void	deleteTrashEntry(long classPK) Deletes the model entity with the primary key.
String	getClassName() Returns the class name handled by this trash handler.
ContainerModel	getContainerModel(long containerModelId) Returns the container model with the primary key.
String	getContainerModelClassName() Deprecated. As of Wilberforce (7.0.x), replaced by getContainerModelClassName(long)
String	getContainerModelClassName(long classPK)
String	getContainerModelName() Returns the name of the container model (e.g. folder name).
List<ContainerModel>	getContainerModels(long classPK, long containerModelId, int start, int end) Returns a range of all the container models that are children of the parent container model identified by the container model ID.
int	getContainerModelsCount(long classPK, long containerModelId) Returns the number of container models that are children of the parent container model identified by the container model ID.
String	getDeleteMessage() Returns the language key to the localized message to display next to a trash entry listed in a search result, indicating that the trash entry was found in a trashed container (e.g. folder or message board thread) this trash handler is associated with.
long	getDestinationContainerModelId(long classPK, long destinationContainerModelId)
Filter	getExcludeFilter(SearchContext searchContext)
Query	getExcludeQuery(SearchContext searchContext) Deprecated. As of Wilberforce (7.0.x), replaced by getExcludeFilter(SearchContext)
ContainerModel	getParentContainerModel(long classPK) Returns the parent container model of the model entity with the primary key.
ContainerModel	getParentContainerModel(TrashedModel trashedModel)
List<ContainerModel>	getParentContainerModels(long classPK) Returns all the parent container models of the model entity with the primary key ordered by hierarchy.
String	getRestoreContainedModelLink(PortletRequest portletRequest, long classPK)
String	getRestoreContainerModelLink(PortletRequest portletRequest, long classPK) Returns the link to the location to which the model entity was restored.
String	getRestoreMessage(PortletRequest portletRequest, long classPK) Returns the message describing the location to which the model entity was restored.
String	getRootContainerModelName() Returns the name of the root container (e.g.
String	getSubcontainerModelName() Returns the name of the subcontainer model (e.g. for a folder the subcontainer model name may be "subfolder").
String	getSystemEventClassName()
String	getTrashContainedModelName() Returns the name of the contained model.
int	getTrashContainedModelsCount(long classPK) Returns the number of model entities (excluding container model entities) that are children of the parent container model identified by the primary key.
List<TrashRenderer>	getTrashContainedModelTrashRenderers(long classPK, int start, int end) Returns a range of all the trash renderers of model entities (excluding container models) that are children of the parent container model identified by the primary key.
String	getTrashContainerModelName() Returns the name of the container model.
int	getTrashContainerModelsCount(long classPK) Returns the number of container models that are children of the parent container model identified by the primary key.
List<TrashRenderer>	getTrashContainerModelTrashRenderers(long classPK, int start, int end) Returns a range of all the trash renderers of model entities that are children of the parent container model identified by the primary key.
TrashEntry	getTrashEntry(long classPK)
int	getTrashModelsCount(long classPK)
List<TrashRenderer>	getTrashModelTrashRenderers(long classPK, int start, int end, OrderByComparator<?> obc)
TrashRenderer	getTrashRenderer(long classPK) Returns the trash renderer associated to the model entity with the primary key.
boolean	hasTrashPermission(PermissionChecker permissionChecker, long groupId, long classPK, String trashActionId) Returns true if the user has the required permission to perform the trash action on the model entity with the primary key.
boolean	isContainerModel() Returns true if the entity is a container model.
boolean	isDeletable() Returns true if the entity can be deleted from the Recycle Bin.
boolean	isInTrash(long classPK) Returns true if the model entity with the primary key is in the Recycle Bin.
boolean	isInTrashContainer(long classPK) Returns true if the model entity with the primary key is in a container that is in the Recycle Bin.
boolean	isMovable() Returns true if the entity can be moved from one container model (such as a folder) to another.
boolean	isRestorable(long classPK) Returns true if the model entity can be restored to its original location.
void	moveEntry(long userId, long classPK, long containerModelId, ServiceContext serviceContext) Moves the entity with the class primary key to the container model with the class primary key
void	moveTrashEntry(long userId, long classPK, long containerModelId, ServiceContext serviceContext) Moves the model entity with the primary key out of the Recycle Bin to a new destination identified by the container model ID.
void	restoreRelatedTrashEntry(String className, long classPK) Restores the model entity that is related to the model entity with the class name and class PK.
void	restoreTrashEntry(long userId, long classPK) Restores the model entity with the primary key.
void	updateTitle(long classPK, String title) Updates the title of the model entity with the primary key.

Method Detail

addDeletionSystemEvent

SystemEvent addDeletionSystemEvent(long userId,
                                   long groupId,
                                   long classPK,
                                   String classUuid,
                                   String referrerClassName)
                            throws PortalException

Throws:

PortalException

checkDuplicateEntry

@Deprecated
void checkDuplicateEntry(long classPK,
                                     long containerModelId,
                                     String newName)
                              throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by checkRestorableEntry(long, long, String)

Throws:

PortalException

checkDuplicateTrashEntry

@Deprecated
void checkDuplicateTrashEntry(TrashEntry trashEntry,
                                          long containerModelId,
                                          String newName)
                                   throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by checkRestorableEntry(TrashEntry, long, String)

Checks if a duplicate trash entry already exists in the destination container.

This method is used to check for duplicates when a trash entry is being restored or moved out of the Recycle Bin.

Parameters:

trashEntry - the trash entry to check

containerModelId - the primary key of the destination (e.g. folder)

newName - the new name to be assigned to the trash entry (optionally null to forego renaming the trash entry)

Throws:

PortalException

checkRestorableEntry

void checkRestorableEntry(long classPK,
                          long containerModelId,
                          String newName)
                   throws PortalException

Throws:

PortalException

checkRestorableEntry

void checkRestorableEntry(TrashEntry trashEntry,
                          long containerModelId,
                          String newName)
                   throws PortalException

Checks if a duplicate trash entry already exists in the destination container.

This method is used to check for duplicates when a trash entry is being restored or moved out of the Recycle Bin.

Parameters:

trashEntry - the trash entry to check

containerModelId - the primary key of the destination (e.g. folder)

newName - the new name to be assigned to the trash entry (optionally null to forego renaming the trash entry)

Throws:

PortalException

deleteTrashEntry

void deleteTrashEntry(long classPK)
               throws PortalException

Deletes the model entity with the primary key.

Parameters:

classPK - the primary key of the model entity to delete

Throws:

PortalException

getClassName

String getClassName()

Returns the class name handled by this trash handler.

Returns:

the class name handled by this trash handler

getContainerModel

ContainerModel getContainerModel(long containerModelId)
                          throws PortalException

Returns the container model with the primary key.

Parameters:

containerModelId - the primary key of the container model

Returns:

the container model with the primary key

Throws:

PortalException

getContainerModelClassName

@Deprecated
String getContainerModelClassName()

Deprecated. As of Wilberforce (7.0.x), replaced by getContainerModelClassName(long)

Returns the parent container model's class name.

getContainerModelClassName

String getContainerModelClassName(long classPK)

getContainerModelName

String getContainerModelName()

Returns the name of the container model (e.g. folder name).

Returns:

the name of the container model

getContainerModels

List<ContainerModel> getContainerModels(long classPK,
                                        long containerModelId,
                                        int start,
                                        int end)
                                 throws PortalException

Returns a range of all the container models that are children of the parent container model identified by the container model ID. These container models must be able to contain the model entity identified by the primary key.

This method checks for the view permission when retrieving the container models.

Useful when paginating results. Returns a maximum of end - start instances. The start and end values are not primary keys but, rather, indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

classPK - the primary key of a model entity the container models must be able to contain

containerModelId - the primary key of the parent container model

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching container models

Throws:

PortalException

getContainerModelsCount

int getContainerModelsCount(long classPK,
                            long containerModelId)
                     throws PortalException

Returns the number of container models that are children of the parent container model identified by the container model ID. These container models must be able to contain the model entity identified by the primary key.

This method checks for the view permission when counting the container models.

Parameters:

classPK - the primary key of a model entity the container models must be able to contain

containerModelId - the primary key of the parent container model

Returns:

the number of matching container models

Throws:

PortalException

getDeleteMessage

String getDeleteMessage()

Returns the language key to the localized message to display next to a trash entry listed in a search result, indicating that the trash entry was found in a trashed container (e.g. folder or message board thread) this trash handler is associated with.

If the language key (e.g. found-in-deleted-folder-x) used accepts a single parameter, the trash framework replaces that parameter with the trashed container's name.

Returns:

the language key to the localized message to display next to a trash entry listed in a search result

getDestinationContainerModelId

long getDestinationContainerModelId(long classPK,
                                    long destinationContainerModelId)

getExcludeFilter

Filter getExcludeFilter(SearchContext searchContext)

getExcludeQuery

@Deprecated
Query getExcludeQuery(SearchContext searchContext)

Deprecated. As of Wilberforce (7.0.x), replaced by getExcludeFilter(SearchContext)

getParentContainerModel

ContainerModel getParentContainerModel(long classPK)
                                throws PortalException

Returns the parent container model of the model entity with the primary key.

Parameters:

classPK - the primary key of a model entity the container models must be able to contain

Returns:

the parent container model of the model entity with the primary key

Throws:

PortalException

getParentContainerModel

ContainerModel getParentContainerModel(TrashedModel trashedModel)
                                throws PortalException

Throws:

PortalException

getParentContainerModels

List<ContainerModel> getParentContainerModels(long classPK)
                                       throws PortalException

Returns all the parent container models of the model entity with the primary key ordered by hierarchy.

For example, if the primary key is for a file entry inside folder C, which is inside folder B, which is inside folder A; this method returns container models for folders A, B, and C.

Parameters:

classPK - the primary key of a model entity the container models must be able to contain

Returns:

all the matching parent container models of the model entity

Throws:

PortalException

getRestoreContainedModelLink

String getRestoreContainedModelLink(PortletRequest portletRequest,
                                    long classPK)
                             throws PortalException

Throws:

PortalException

getRestoreContainerModelLink

String getRestoreContainerModelLink(PortletRequest portletRequest,
                                    long classPK)
                             throws PortalException

Returns the link to the location to which the model entity was restored.

Parameters:

portletRequest - the portlet request

classPK - the primary key of the restored model entity

Returns:

the restore link

Throws:

PortalException

getRestoreMessage

String getRestoreMessage(PortletRequest portletRequest,
                         long classPK)
                  throws PortalException

Returns the message describing the location to which the model entity was restored.

Parameters:

portletRequest - the portlet request

classPK - the primary key of the restored model entity

Returns:

the restore message

Throws:

PortalException

getRootContainerModelName

String getRootContainerModelName()

Returns the name of the root container (e.g. "home").

Returns:

the name of the root container

getSubcontainerModelName

String getSubcontainerModelName()

Returns the name of the subcontainer model (e.g. for a folder the subcontainer model name may be "subfolder").

Returns:

the name of the subcontainer model

getSystemEventClassName

String getSystemEventClassName()

getTrashContainedModelName

String getTrashContainedModelName()

Returns the name of the contained model.

For example, "files" may be the model name for a folder and "pages" may be the model name for a wiki node.

Returns:

the name of the contained model

getTrashContainedModelsCount

int getTrashContainedModelsCount(long classPK)
                          throws PortalException

Returns the number of model entities (excluding container model entities) that are children of the parent container model identified by the primary key.

For example, for a folder with subfolders and documents, the number of documents (excluding those explicitely moved to the recycle bin) is returned.

Parameters:

classPK - the primary key of a container model

Returns:

the number of model entities that are children of the parent container model identified by the primary key

Throws:

PortalException

getTrashContainedModelTrashRenderers

List<TrashRenderer> getTrashContainedModelTrashRenderers(long classPK,
                                                         int start,
                                                         int end)
                                                  throws PortalException

Returns a range of all the trash renderers of model entities (excluding container models) that are children of the parent container model identified by the primary key.

For example, for a folder with subfolders and documents, a range of all the trash renderers of documents (excluding those explicitly moved to the recycle bin) is returned.

Useful when paginating results. Returns a maximum of end - start instances. The start and end values are not primary keys but, rather, indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

classPK - the primary key of a container model

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of trash renderers of model entities (excluding container models) that are children of the parent container model identified by the primary key

Throws:

PortalException

getTrashContainerModelName

String getTrashContainerModelName()

Returns the name of the container model.

For example, "folder" may be the container model name for a file entry.

Returns:

the name of the container model

getTrashContainerModelsCount

int getTrashContainerModelsCount(long classPK)
                          throws PortalException

Returns the number of container models that are children of the parent container model identified by the primary key.

For example, for a folder with subfolders and documents, the number of folders (excluding those explicitly moved to the recycle bin) is returned.

Parameters:

classPK - the primary key of a container model

Returns:

the number of container models that are children of the parent container model identified by the primary key

Throws:

PortalException

getTrashContainerModelTrashRenderers

List<TrashRenderer> getTrashContainerModelTrashRenderers(long classPK,
                                                         int start,
                                                         int end)
                                                  throws PortalException

Returns a range of all the trash renderers of model entities that are children of the parent container model identified by the primary key.

For example, for a folder with subfolders and documents, the range of renderers representing folders (excluding those explicitly moved to the recycle bin) is returned.

Useful when paginating results. Returns a maximum of end - start instances. The start and end values are not primary keys but, rather, indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

classPK - the primary key of a container model

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching trash renderers of model entities

Throws:

PortalException

getTrashEntry

TrashEntry getTrashEntry(long classPK)
                  throws PortalException

Throws:

PortalException

getTrashModelsCount

int getTrashModelsCount(long classPK)
                 throws PortalException

Throws:

PortalException

getTrashModelTrashRenderers

List<TrashRenderer> getTrashModelTrashRenderers(long classPK,
                                                int start,
                                                int end,
                                                OrderByComparator<?> obc)
                                         throws PortalException

Throws:

PortalException

getTrashRenderer

TrashRenderer getTrashRenderer(long classPK)
                        throws PortalException

Returns the trash renderer associated to the model entity with the primary key.

Parameters:

classPK - the primary key of the model entity

Returns:

the trash renderer associated to the model entity

Throws:

PortalException

hasTrashPermission

boolean hasTrashPermission(PermissionChecker permissionChecker,
                           long groupId,
                           long classPK,
                           String trashActionId)
                    throws PortalException

Returns true if the user has the required permission to perform the trash action on the model entity with the primary key.

This method is a mapper for special Recycle Bin operations that are not real permissions. The implementations of this method should translate these virtual permissions to real permission checks.

Parameters:

permissionChecker - the permission checker

groupId - the primary key of the group

classPK - the primary key of the model entity

trashActionId - the trash action permission to check

Returns:

true if the user has the required permission; false otherwise

Throws:

PortalException

isContainerModel

boolean isContainerModel()

Returns true if the entity is a container model.

Returns:

true if the entity is a container model; false otherwise

isDeletable

boolean isDeletable()

Returns true if the entity can be deleted from the Recycle Bin.

Returns:

true if the entity can be deleted from the Recycle Bin.

isInTrash

boolean isInTrash(long classPK)
           throws PortalException

Returns true if the model entity with the primary key is in the Recycle Bin.

Parameters:

classPK - the primary key of the model entity

Returns:

true if the model entity is in the Recycle Bin; false otherwise

Throws:

PortalException

isInTrashContainer

boolean isInTrashContainer(long classPK)
                    throws PortalException

Returns true if the model entity with the primary key is in a container that is in the Recycle Bin.

Parameters:

classPK - the primary key of the model entity

Returns:

true if the model entity with the primary key is in a container that is in the Recycle Bin; false otherwise

Throws:

PortalException

isMovable

boolean isMovable()

Returns true if the entity can be moved from one container model (such as a folder) to another.

Returns:

true if the entity can be moved from one container model to another; false otherwise

isRestorable

boolean isRestorable(long classPK)
              throws PortalException

Returns true if the model entity can be restored to its original location.

This method usually returns false if the container (e.g. folder) of the model entity is no longer available (e.g. moved to the Recycle Bin or deleted).

Parameters:

classPK - the primary key of the model entity

Returns:

true if the model entity can be restored to its original location; false otherwise

Throws:

PortalException

moveEntry

void moveEntry(long userId,
               long classPK,
               long containerModelId,
               ServiceContext serviceContext)
        throws PortalException

Moves the entity with the class primary key to the container model with the class primary key

Parameters:

userId - the user ID

classPK - the primary key of the model entity

containerModelId - the primary key of the destination container model

serviceContext - the service context to be applied

Throws:

PortalException

moveTrashEntry

void moveTrashEntry(long userId,
                    long classPK,
                    long containerModelId,
                    ServiceContext serviceContext)
             throws PortalException

Moves the model entity with the primary key out of the Recycle Bin to a new destination identified by the container model ID.

Parameters:

userId - the user ID

classPK - the primary key of the model entity

containerModelId - the primary key of the destination container model

serviceContext - the service context to be applied

Throws:

PortalException

restoreRelatedTrashEntry

void restoreRelatedTrashEntry(String className,
                              long classPK)
                       throws PortalException

Restores the model entity that is related to the model entity with the class name and class PK. For example, com.liferay.portlet.wiki.trash.WikiPageTrashHandler#restoreRelatedTrashEntry( String, long) restores the attachment related to the wiki page with the class name and class PK.

Parameters:

className - the class name of the model entity with a related model entity to restore

classPK - the primary key of the model entity with a related model entity to restore

Throws:

PortalException

restoreTrashEntry

void restoreTrashEntry(long userId,
                       long classPK)
                throws PortalException

Restores the model entity with the primary key.

Parameters:

userId - the user ID

classPK - the primary key of the model entity to restore

Throws:

PortalException

updateTitle

void updateTitle(long classPK,
                 String title)
          throws PortalException

Updates the title of the model entity with the primary key. This method is called by com.liferay.portlet.trash.action.EditEntryAction before restoring the model entity via its restore rename action.

Parameters:

classPK - the primary key of the model entity

title - the title to be assigned

Throws:

PortalException