Liferay 6.2.0-ce-m4

com.liferay.portlet.documentlibrary.trash
Class DLFileShortcutTrashHandler

java.lang.Object
  extended by com.liferay.portal.kernel.trash.BaseTrashHandler
      extended by com.liferay.portlet.documentlibrary.trash.DLBaseTrashHandler
          extended by com.liferay.portlet.documentlibrary.trash.DLFileShortcutTrashHandler
All Implemented Interfaces:
TrashHandler

public class DLFileShortcutTrashHandler
extends DLBaseTrashHandler

Implements trash handling for the file shortcut entity.


Field Summary
static String CLASS_NAME
           
 
Constructor Summary
DLFileShortcutTrashHandler()
           
 
Method Summary
 void deleteTrashEntries(long[] classPKs, boolean checkPermission)
          Deletes all the model entities with the primary keys, optionally checking permission before deleting each model entity.
 String getClassName()
          Returns the class name handled by this trash handler.
protected  DLFileShortcut getDLFileShortcut(long classPK)
           
 ContainerModel getParentContainerModel(long classPK)
          Returns the parent container model of the model entity with the primary key.
protected  Repository getRepository(long classPK)
           
 String getRestoreLink(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.
 TrashRenderer getTrashRenderer(long classPK)
          Returns the trash renderer associated to the model entity with the primary key.
protected  boolean hasPermission(PermissionChecker permissionChecker, long classPK, String actionId)
           
 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 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 isRestorable(long classPK)
          Returns true if the model entity can be restored to its original location.
 void moveEntry(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 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 restoreTrashEntries(long[] classPKs)
          Restores all the model entities with the primary keys.
 
Methods inherited from class com.liferay.portlet.documentlibrary.trash.DLBaseTrashHandler
getContainerModel, getContainerModelClassName, getContainerModelName, getContainerModels, getContainerModelsCount, getDLFolder, getParentContainerModels, getRootContainerModelName, getTrashContainedModelName, getTrashContainedModelsCount, getTrashContainedModelTrashRenderers, getTrashContainerModelName, getTrashContainerModelsCount, getTrashContainerModelTrashRenderers, isMovable
 
Methods inherited from class com.liferay.portal.kernel.trash.BaseTrashHandler
checkDuplicateTrashEntry, deleteTrashEntries, deleteTrashEntry, deleteTrashEntry, getAssetRendererFactory, getDeleteMessage, getSubcontainerModelName, isContainerModel, isDeletable, restoreRelatedTrashEntry, restoreTrashEntry, updateTitle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
Constructor Detail

DLFileShortcutTrashHandler

public DLFileShortcutTrashHandler()
Method Detail

deleteTrashEntries

public void deleteTrashEntries(long[] classPKs,
                               boolean checkPermission)
                        throws PortalException,
                               SystemException
Description copied from interface: TrashHandler
Deletes all the model entities with the primary keys, optionally checking permission before deleting each model entity.

Parameters:
classPKs - the primary keys of the model entities to delete
checkPermission - whether to check permission before deleting each model entity
Throws:
PortalException - if any one of the model entities could not be found
SystemException - if a system exception occurred

getClassName

public String getClassName()
Description copied from interface: TrashHandler
Returns the class name handled by this trash handler.

Returns:
the class name handled by this trash handler

getParentContainerModel

public ContainerModel getParentContainerModel(long classPK)
                                       throws PortalException,
                                              SystemException
Description copied from interface: TrashHandler
Returns the parent container model of the model entity with the primary key.

Specified by:
getParentContainerModel in interface TrashHandler
Overrides:
getParentContainerModel in class BaseTrashHandler
Parameters:
classPK - the primary key of a model entity the container models must be able to contain
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

getRestoreLink

public String getRestoreLink(PortletRequest portletRequest,
                             long classPK)
                      throws PortalException,
                             SystemException
Description copied from interface: TrashHandler
Returns the link to the location to which the model entity was restored.

Specified by:
getRestoreLink in interface TrashHandler
Overrides:
getRestoreLink in class BaseTrashHandler
Parameters:
portletRequest - the portlet request
classPK - the primary key of the restored model entity
Returns:
the restore link
Throws:
PortalException - if a model entity with the primary key could not be found
SystemException - if a system exception occurred

getRestoreMessage

public String getRestoreMessage(PortletRequest portletRequest,
                                long classPK)
                         throws PortalException,
                                SystemException
Description copied from interface: TrashHandler
Returns the message describing the location to which the model entity was restored.

Specified by:
getRestoreMessage in interface TrashHandler
Overrides:
getRestoreMessage in class BaseTrashHandler
Parameters:
portletRequest - the portlet request
classPK - the primary key of the restored model entity
Returns:
the restore message
Throws:
PortalException - if a model entity with the primary key could not be found
SystemException - if a system exception occurred

getTrashRenderer

public TrashRenderer getTrashRenderer(long classPK)
                               throws PortalException,
                                      SystemException
Description copied from interface: TrashHandler
Returns the trash renderer associated to the model entity with the primary key.

Specified by:
getTrashRenderer in interface TrashHandler
Overrides:
getTrashRenderer in class BaseTrashHandler
Parameters:
classPK - the primary key of the model entity
Returns:
the trash renderer associated to the model entity
Throws:
PortalException - if a model entity with the primary key could not be found
SystemException - if a system exception occurred

hasTrashPermission

public boolean hasTrashPermission(PermissionChecker permissionChecker,
                                  long groupId,
                                  long classPK,
                                  String trashActionId)
                           throws PortalException,
                                  SystemException
Description copied from interface: TrashHandler
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.

Specified by:
hasTrashPermission in interface TrashHandler
Overrides:
hasTrashPermission in class BaseTrashHandler
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 - if a model entity with the primary key could not be found
SystemException - if a system exception occurred

isInTrash

public boolean isInTrash(long classPK)
                  throws PortalException,
                         SystemException
Description copied from interface: TrashHandler
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 - if a model entity with the primary key could not be found in the portal
SystemException - if a system exception occurred

isInTrashContainer

public boolean isInTrashContainer(long classPK)
                           throws PortalException,
                                  SystemException
Description copied from interface: TrashHandler
Returns true if the model entity with the primary key is in a container that is in the Recycle Bin.

Specified by:
isInTrashContainer in interface TrashHandler
Overrides:
isInTrashContainer in class BaseTrashHandler
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 - if a model entity with the primary key could not be found in the portal
SystemException - if a system exception occurred

isRestorable

public boolean isRestorable(long classPK)
                     throws PortalException,
                            SystemException
Description copied from interface: TrashHandler
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).

Specified by:
isRestorable in interface TrashHandler
Overrides:
isRestorable in class BaseTrashHandler
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 - if a model entity with the primary key could not be found
SystemException - if a system exception occurred

moveEntry

public void moveEntry(long classPK,
                      long containerModelId,
                      ServiceContext serviceContext)
               throws PortalException,
                      SystemException
Description copied from interface: TrashHandler
Moves the entity with the class primary key to the container model with the class primary key

Specified by:
moveEntry in interface TrashHandler
Overrides:
moveEntry in class BaseTrashHandler
Throws:
PortalException
SystemException

moveTrashEntry

public void moveTrashEntry(long classPK,
                           long containerModelId,
                           ServiceContext serviceContext)
                    throws PortalException,
                           SystemException
Description copied from interface: TrashHandler
Moves the model entity with the primary key out of the Recycle Bin to a new destination identified by the container model ID.

Specified by:
moveTrashEntry in interface TrashHandler
Overrides:
moveTrashEntry in class BaseTrashHandler
Parameters:
classPK - the primary key of the model entity
containerModelId - the primary key of the destination container model
serviceContext - the service context
Throws:
PortalException - if a model entity with the primary key or the destination container model with the primary key could not be found
SystemException - if a system exception occurred

restoreTrashEntries

public void restoreTrashEntries(long[] classPKs)
                         throws PortalException,
                                SystemException
Description copied from interface: TrashHandler
Restores all the model entities with the primary keys.

Parameters:
classPKs - the primary keys of the model entities to restore
Throws:
PortalException - if any one of the model entities could not be found
SystemException - if a system exception occurred

getDLFileShortcut

protected DLFileShortcut getDLFileShortcut(long classPK)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getRepository

protected Repository getRepository(long classPK)
                            throws PortalException,
                                   SystemException
Specified by:
getRepository in class DLBaseTrashHandler
Throws:
PortalException
SystemException

hasPermission

protected boolean hasPermission(PermissionChecker permissionChecker,
                                long classPK,
                                String actionId)
                         throws PortalException,
                                SystemException
Specified by:
hasPermission in class BaseTrashHandler
Throws:
PortalException
SystemException

Liferay 6.2.0-ce-m4