|
Liferay 7.0-ce-m3 | |||||||||
| 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.
| Constructor Summary | |
|---|---|
DLFileEntryTrashHandler()
|
|
| Method Summary | |
|---|---|
protected void |
checkRestorableEntry(long classPK,
long entryId,
long containerModelId,
String originalFileName,
String originalTitle,
String newName)
|
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. |
protected DLFileEntry |
fetchDLFileEntry(long classPK)
|
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. |
ContainerModel |
getParentContainerModel(TrashedModel trashedModel)
|
protected Repository |
getRepository(long classPK)
|
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 |
getSystemEventClassName()
|
TrashEntry |
getTrashEntry(long classPK)
|
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 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 |
restoreTrashEntry(long userId,
long classPK)
Restores the model entity with the primary key. |
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 |
|---|
fetchDLFolder, getContainerModel, getContainerModelClassName, getContainerModelName, getContainerModels, getContainerModelsCount, getDLFolder, getParentContainerModels, getRootContainerModelName, getRootContainerModelTitle, getTrashContainedModelName, getTrashContainedModelsCount, getTrashContainedModelTrashRenderers, getTrashContainerModelName, getTrashContainerModelsCount, getTrashContainerModelTrashRenderers, isMovable |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public DLFileEntryTrashHandler()
| Method Detail |
|---|
public void checkRestorableEntry(long classPK,
long containerModelId,
String newName)
throws PortalException
checkRestorableEntry in interface TrashHandlercheckRestorableEntry in class BaseTrashHandlerPortalException
public void checkRestorableEntry(TrashEntry trashEntry,
long containerModelId,
String newName)
throws PortalException
TrashHandlerThis method is used to check for duplicates when a trash entry is being restored or moved out of the Recycle Bin.
checkRestorableEntry in interface TrashHandlercheckRestorableEntry 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
public void deleteTrashEntry(long classPK)
throws PortalException
TrashHandler
classPK - the primary key of the model entity to delete
PortalException - if a model entity with the primary key could not
be foundpublic String getClassName()
TrashHandler
public ContainerModel getParentContainerModel(long classPK)
throws PortalException
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
public ContainerModel getParentContainerModel(TrashedModel trashedModel)
throws PortalException
getParentContainerModel in interface TrashHandlergetParentContainerModel in class BaseTrashHandlerPortalException
public String getRestoreContainedModelLink(PortletRequest portletRequest,
long classPK)
throws PortalException
getRestoreContainedModelLink in interface TrashHandlergetRestoreContainedModelLink in class BaseTrashHandlerPortalException
public String getRestoreContainerModelLink(PortletRequest portletRequest,
long classPK)
throws PortalException
TrashHandler
getRestoreContainerModelLink in interface TrashHandlergetRestoreContainerModelLink 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
public String getRestoreMessage(PortletRequest portletRequest,
long classPK)
throws PortalException
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 foundpublic String getSystemEventClassName()
getSystemEventClassName in interface TrashHandlergetSystemEventClassName in class BaseTrashHandler
public TrashEntry getTrashEntry(long classPK)
throws PortalException
getTrashEntry in interface TrashHandlergetTrashEntry in class BaseTrashHandlerPortalException
public boolean hasTrashPermission(PermissionChecker permissionChecker,
long groupId,
long classPK,
String trashActionId)
throws PortalException
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
public boolean isInTrash(long classPK)
throws PortalException
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
public boolean isInTrashContainer(long classPK)
throws PortalException
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
public boolean isRestorable(long classPK)
throws PortalException
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
public void moveEntry(long userId,
long classPK,
long containerModelId,
ServiceContext serviceContext)
throws PortalException
TrashHandler
moveEntry in interface TrashHandlermoveEntry in class BaseTrashHandleruserId - the user IDclassPK - the primary key of the model entitycontainerModelId - the primary key of the destination container
modelserviceContext - the service context to be applied
PortalException - if a model entity with the primary key or the
destination container model with the primary key could not be
found
public void moveTrashEntry(long userId,
long classPK,
long containerModelId,
ServiceContext serviceContext)
throws PortalException
TrashHandler
moveTrashEntry in interface TrashHandlermoveTrashEntry in class BaseTrashHandleruserId - the user IDclassPK - the primary key of the model entitycontainerModelId - the primary key of the destination container
modelserviceContext - the service context to be applied
PortalException - if a model entity with the primary key or the
destination container model with the primary key could not be
found
public void restoreTrashEntry(long userId,
long classPK)
throws PortalException
TrashHandler
userId - the user IDclassPK - the primary key of the model entity to restore
PortalException - if a model entity with the primary key could not
be found
public void updateTitle(long classPK,
String name)
throws PortalException
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
protected void checkRestorableEntry(long classPK,
long entryId,
long containerModelId,
String originalFileName,
String originalTitle,
String newName)
throws PortalException
PortalException
protected DLFileEntry fetchDLFileEntry(long classPK)
throws PortalException
PortalException
protected DLFileEntry getDLFileEntry(long classPK)
throws PortalException
PortalException
protected Repository getRepository(long classPK)
throws PortalException
getRepository in class DLBaseTrashHandlerPortalException
protected boolean hasPermission(PermissionChecker permissionChecker,
long classPK,
String actionId)
throws PortalException
hasPermission in class BaseTrashHandlerPortalException
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||