|
Liferay 6.2.0-ce-m4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.kernel.trash.BaseTrashHandler
com.liferay.portlet.documentlibrary.trash.DLBaseTrashHandler
com.liferay.portlet.documentlibrary.trash.DLFileEntryTrashHandler
public class DLFileEntryTrashHandler
Implements trash handling for the file entry entity.
| Field Summary | |
|---|---|
static String |
CLASS_NAME
|
| Constructor Summary | |
|---|---|
DLFileEntryTrashHandler()
|
|
| Method Summary | |
|---|---|
void |
checkDuplicateTrashEntry(TrashEntry trashEntry,
long containerModelId,
String newName)
Checks if a duplicate trash entry already exists in the destination container. |
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 DLFileEntry |
getDLFileEntry(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. |
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. |
void |
updateTitle(long classPK,
String name)
Updates the title of the model entity with the primary key. |
| 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 |
|---|
deleteTrashEntries, deleteTrashEntry, deleteTrashEntry, getAssetRendererFactory, getDeleteMessage, getSubcontainerModelName, getTrashRenderer, isContainerModel, isDeletable, restoreRelatedTrashEntry, restoreTrashEntry |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String CLASS_NAME
| Constructor Detail |
|---|
public DLFileEntryTrashHandler()
| Method Detail |
|---|
public void checkDuplicateTrashEntry(TrashEntry trashEntry,
long containerModelId,
String newName)
throws PortalException,
SystemException
TrashHandlerThis method is used to check for duplicates when a trash entry is being restored or moved out of the Recycle Bin.
checkDuplicateTrashEntry in interface TrashHandlercheckDuplicateTrashEntry in class BaseTrashHandlertrashEntry - the trash entry to checkcontainerModelId - 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)
PortalException - if a duplicate trash entry already existed in the
destination container
SystemException - if a system exception occurred
public void deleteTrashEntries(long[] classPKs,
boolean checkPermission)
throws PortalException,
SystemException
TrashHandler
classPKs - the primary keys of the model entities to deletecheckPermission - whether to check permission before deleting each
model entity
PortalException - if any one of the model entities could not be
found
SystemException - if a system exception occurredpublic String getClassName()
TrashHandler
public ContainerModel getParentContainerModel(long classPK)
throws PortalException,
SystemException
TrashHandler
getParentContainerModel in interface TrashHandlergetParentContainerModel in class BaseTrashHandlerclassPK - the primary key of a model entity the container models
must be able to contain
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public String getRestoreLink(PortletRequest portletRequest,
long classPK)
throws PortalException,
SystemException
TrashHandler
getRestoreLink in interface TrashHandlergetRestoreLink in class BaseTrashHandlerportletRequest - the portlet requestclassPK - the primary key of the restored model entity
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurred
public String getRestoreMessage(PortletRequest portletRequest,
long classPK)
throws PortalException,
SystemException
TrashHandler
getRestoreMessage in interface TrashHandlergetRestoreMessage in class BaseTrashHandlerportletRequest - the portlet requestclassPK - the primary key of the restored model entity
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurred
public boolean hasTrashPermission(PermissionChecker permissionChecker,
long groupId,
long classPK,
String trashActionId)
throws PortalException,
SystemException
TrashHandlertrue 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.
hasTrashPermission in interface TrashHandlerhasTrashPermission in class BaseTrashHandlerpermissionChecker - the permission checkergroupId - the primary key of the groupclassPK - the primary key of the model entitytrashActionId - the trash action permission to check
true if the user has the required permission;
false otherwise
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurred
public boolean isInTrash(long classPK)
throws PortalException,
SystemException
TrashHandlertrue if the model entity with the primary key is in
the Recycle Bin.
classPK - the primary key of the model entity
true if the model entity is in the Recycle Bin;
false otherwise
PortalException - if a model entity with the primary key could not
be found in the portal
SystemException - if a system exception occurred
public boolean isInTrashContainer(long classPK)
throws PortalException,
SystemException
TrashHandlertrue if the model entity with the primary key is in
a container that is in the Recycle Bin.
isInTrashContainer in interface TrashHandlerisInTrashContainer in class BaseTrashHandlerclassPK - the primary key of the model entity
true if the model entity with the primary key is in
a container that is in the Recycle Bin; false
otherwise
PortalException - if a model entity with the primary key could not
be found in the portal
SystemException - if a system exception occurred
public boolean isRestorable(long classPK)
throws PortalException,
SystemException
TrashHandlertrue 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).
isRestorable in interface TrashHandlerisRestorable in class BaseTrashHandlerclassPK - the primary key of the model entity
true if the model entity can be restored to its
original location; false otherwise
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurred
public void moveEntry(long classPK,
long containerModelId,
ServiceContext serviceContext)
throws PortalException,
SystemException
TrashHandler
moveEntry in interface TrashHandlermoveEntry in class BaseTrashHandlerPortalException
SystemException
public void moveTrashEntry(long classPK,
long containerModelId,
ServiceContext serviceContext)
throws PortalException,
SystemException
TrashHandler
moveTrashEntry in interface TrashHandlermoveTrashEntry in class BaseTrashHandlerclassPK - the primary key of the model entitycontainerModelId - the primary key of the destination container
modelserviceContext - the service context
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
public void restoreTrashEntries(long[] classPKs)
throws PortalException,
SystemException
TrashHandler
classPKs - the primary keys of the model entities to restore
PortalException - if any one of the model entities could not be
found
SystemException - if a system exception occurred
public void updateTitle(long classPK,
String name)
throws PortalException,
SystemException
TrashHandlerEditEntryAction
before restoring the model entity via its restore rename action.
updateTitle in interface TrashHandlerupdateTitle in class BaseTrashHandlerclassPK - the primary key of the model entityname - the title to be assigned
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurred
protected DLFileEntry getDLFileEntry(long classPK)
throws PortalException,
SystemException
PortalException
SystemException
protected Repository getRepository(long classPK)
throws PortalException,
SystemException
getRepository in class DLBaseTrashHandlerPortalException
SystemException
protected boolean hasPermission(PermissionChecker permissionChecker,
long classPK,
String actionId)
throws PortalException,
SystemException
hasPermission in class BaseTrashHandlerPortalException
SystemException
|
Liferay 6.2.0-ce-m4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||