|
Liferay 6.2.0-ce-b2 | |||||||||
| 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.bookmarks.trash.BookmarksBaseTrashHandler
com.liferay.portlet.bookmarks.trash.BookmarksFolderTrashHandler
public class BookmarksFolderTrashHandler
Represents the trash handler for bookmarks folder entity.
| Constructor Summary | |
|---|---|
BookmarksFolderTrashHandler()
|
|
| Method Summary | |
|---|---|
void |
deleteTrashEntry(long classPK)
Deletes the model entity with the primary key. |
protected BookmarksFolder |
getBookmarksFolder(long classPK)
|
String |
getClassName()
Returns the class name handled by this trash handler. |
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. |
protected long |
getGroupId(long classPK)
|
ContainerModel |
getParentContainerModel(long classPK)
Returns the parent container model of the model entity with the primary key. |
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. |
ContainerModel |
getTrashContainer(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 |
isContainerModel()
Returns true if the entity is a container model. |
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 containerId,
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. |
| Methods inherited from class com.liferay.portlet.bookmarks.trash.BookmarksBaseTrashHandler |
|---|
getContainerModel, getContainerModelClassName, getContainerModelName, getContainerModels, getContainerModelsCount, getParentContainerModels, getRootContainerModelName, getTrashContainedModelName, getTrashContainedModelsCount, getTrashContainedModelTrashRenderers, getTrashContainerModelName, getTrashContainerModelsCount, getTrashContainerModelTrashRenderers, isMovable |
| Methods inherited from class com.liferay.portal.kernel.trash.BaseTrashHandler |
|---|
checkDuplicateEntry, checkDuplicateTrashEntry, getAssetRendererFactory, getSubcontainerModelName, isDeletable, restoreRelatedTrashEntry, updateTitle |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public BookmarksFolderTrashHandler()
| Method Detail |
|---|
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 getDeleteMessage()
TrashHandler
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.
getDeleteMessage in interface TrashHandlergetDeleteMessage 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 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 ContainerModel getTrashContainer(long classPK)
throws PortalException,
SystemException
getTrashContainer in interface TrashHandlergetTrashContainer 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 occurredpublic boolean isContainerModel()
TrashHandlertrue if the entity is a container model.
isContainerModel in interface TrashHandlerisContainerModel in class BaseTrashHandlertrue if the entity is a container model;
false otherwise
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 userId,
long classPK,
long containerModelId,
ServiceContext serviceContext)
throws PortalException,
SystemException
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
SystemException - if a system exception occurred
public void moveTrashEntry(long userId,
long classPK,
long containerId,
ServiceContext serviceContext)
throws PortalException,
SystemException
TrashHandler
moveTrashEntry in interface TrashHandlermoveTrashEntry in class BaseTrashHandleruserId - the user IDclassPK - the primary key of the model entitycontainerId - 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
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
protected BookmarksFolder getBookmarksFolder(long classPK)
throws PortalException,
SystemException
PortalException
SystemException
protected long getGroupId(long classPK)
throws PortalException,
SystemException
getGroupId in class BookmarksBaseTrashHandlerPortalException
SystemException
protected boolean hasPermission(PermissionChecker permissionChecker,
long classPK,
String actionId)
throws PortalException,
SystemException
hasPermission in class BaseTrashHandlerPortalException
SystemException
|
Liferay 6.2.0-ce-b2 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||