|
Liferay 6.2-ce-ga4 | |||||||||
| 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.wiki.trash.WikiPageTrashHandler
public class WikiPageTrashHandler
Implements trash handling for the wiki page entity.
| Constructor Summary | |
|---|---|
WikiPageTrashHandler()
|
|
| Method Summary | |
|---|---|
SystemEvent |
addDeletionSystemEvent(long userId,
long groupId,
long classPK,
String classUuid,
String referrerClassName)
|
void |
checkDuplicateTrashEntry(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. |
String |
getContainerModelClassName()
Returns the parent container model's class name. |
String |
getContainerModelName()
Returns the name of the container model (e.g. folder name). |
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. |
protected PortletURL |
getRestoreURL(PortletRequest portletRequest,
long classPK,
boolean isContainerModel)
|
TrashEntry |
getTrashEntry(long classPK)
|
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. |
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 name)
Updates the title of the model entity with the primary key. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public WikiPageTrashHandler()
| Method Detail |
|---|
public SystemEvent addDeletionSystemEvent(long userId,
long groupId,
long classPK,
String classUuid,
String referrerClassName)
throws PortalException,
SystemException
addDeletionSystemEvent in interface TrashHandleraddDeletionSystemEvent in class BaseTrashHandlerPortalException
SystemException
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 deleteTrashEntry(long classPK)
throws PortalException,
SystemException
TrashHandler
classPK - the primary key of the model entity to delete
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurredpublic String getClassName()
TrashHandler
public String getContainerModelClassName()
TrashHandler
getContainerModelClassName in interface TrashHandlergetContainerModelClassName in class BaseTrashHandlerpublic String getContainerModelName()
TrashHandler
getContainerModelName in interface TrashHandlergetContainerModelName in class BaseTrashHandler
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 occurredpublic ContainerModel getParentContainerModel(TrashedModel trashedModel)
getParentContainerModel in interface TrashHandlergetParentContainerModel in class BaseTrashHandler
public List<ContainerModel> getParentContainerModels(long classPK)
throws PortalException,
SystemException
TrashHandlerFor 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.
getParentContainerModels in interface TrashHandlergetParentContainerModels 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 getRestoreContainedModelLink(PortletRequest portletRequest,
long classPK)
throws PortalException,
SystemException
getRestoreContainedModelLink in interface TrashHandlergetRestoreContainedModelLink in class BaseTrashHandlerPortalException
SystemException
public String getRestoreContainerModelLink(PortletRequest portletRequest,
long classPK)
throws PortalException,
SystemException
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
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 TrashEntry getTrashEntry(long classPK)
throws PortalException,
SystemException
getTrashEntry in interface TrashHandlergetTrashEntry in class BaseTrashHandlerPortalException
SystemException
public TrashRenderer getTrashRenderer(long classPK)
throws PortalException,
SystemException
TrashHandler
getTrashRenderer in interface TrashHandlergetTrashRenderer in class BaseTrashHandlerclassPK - the primary key of the 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 void restoreRelatedTrashEntry(String className,
long classPK)
throws PortalException,
SystemException
TrashHandlerrestoreRelatedTrashEntry(
String, long) restores the attachment related to the wiki page with the
class name and class PK.
restoreRelatedTrashEntry in interface TrashHandlerrestoreRelatedTrashEntry in class BaseTrashHandlerclassName - the class name of the model entity with a related model
entity to restoreclassPK - the primary key of the model entity with a related model
entity to restore
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurred
public void restoreTrashEntry(long userId,
long classPK)
throws PortalException,
SystemException
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
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 PortletURL getRestoreURL(PortletRequest portletRequest,
long classPK,
boolean isContainerModel)
throws PortalException,
SystemException
PortalException
SystemException
protected boolean hasPermission(PermissionChecker permissionChecker,
long classPK,
String actionId)
throws PortalException,
SystemException
hasPermission in class BaseTrashHandlerPortalException
SystemException
|
Liferay 6.2-ce-ga4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||