|
Liferay 6.2.0-ce-m1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface TrashHandler
The interface for managing the basic trash operations of the Recycle Bin, which include:
These operations are supported for the following entities via their respective trash handlers:
BlogsEntryTrashHandler
com.liferay.portlet.bookmarks.trash.BookmarksEntryTrashHandler
DLFileEntryTrashHandler
DLFileShortcutTrashHandler
DLFolderTrashHandler
MBThreadTrashHandler
WikiNodeTrashHandler
WikiPageTrashHandler
| Method Summary | |
|---|---|
void |
checkDuplicateTrashEntry(TrashEntry trashEntry,
long containerModelId,
String newName)
Checks if a duplicate trash entry already exists in the destination container. |
void |
deleteTrashAttachments(Group group,
Date date)
Deletes the group's attachments that were trashed before the given date. |
void |
deleteTrashEntries(long[] classPKs)
Deletes all the model entities with the primary keys. |
void |
deleteTrashEntries(long[] classPKs,
boolean checkPermission)
Deletes all the model entities with the primary keys, optionally checking permission before deleting each model entity. |
void |
deleteTrashEntry(long classPK)
Deletes the model entity with the primary key. |
void |
deleteTrashEntry(long classPK,
boolean checkPermission)
Deletes the model entity with the primary key. |
String |
getClassName()
Returns the class name handled by this trash handler. |
ContainerModel |
getContainerModel(long containerModelId)
Returns the container model with the primary key. |
String |
getContainerModelName()
Returns the name of the container model (e.g. folder name). |
List<ContainerModel> |
getContainerModels(long classPK,
long containerModelId,
int start,
int end)
Returns a range of all the container models that are children of the parent container model identified by the container model ID. |
int |
getContainerModelsCount(long classPK,
long containerModelId)
Returns the number of container models that are children of the parent container model identified by the container model ID. |
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. |
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. |
String |
getRootContainerModelName()
Returns the name of the root container (e.g. |
String |
getSubcontainerModelName()
Returns the name of the sub-container model (e.g. for a folder the sub-container model name may be "subfolder"). |
TrashRenderer |
getTrashRenderer(long classPK)
Returns the trash renderer associated to the model entity with the primary key. |
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 |
isRestorable(long classPK)
Returns true if the model entity can be restored to its
original location. |
TrashEntry |
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 |
restoreTrashEntry(long classPK)
Restores the model entity with the primary key. |
void |
updateTitle(long classPK,
String title)
Updates the title of the model entity with the primary key. |
| Method Detail |
|---|
void checkDuplicateTrashEntry(TrashEntry trashEntry,
long containerModelId,
String newName)
throws PortalException,
SystemException
This method is used to check for duplicates when a trash entry is being restored or moved out of the Recycle Bin.
trashEntry - 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
void deleteTrashAttachments(Group group,
Date date)
throws PortalException,
SystemException
group - ID the primary key of the groupdate - the date from which attachments will be deleted
PortalException - if any one of the attachment file paths were
invalid
SystemException - if a system exception occurred
void deleteTrashEntries(long[] classPKs)
throws PortalException,
SystemException
classPKs - the primary keys of the model entities to delete
PortalException - if any one of the model entities could not be
found
SystemException - if a system exception occurred
void deleteTrashEntries(long[] classPKs,
boolean checkPermission)
throws PortalException,
SystemException
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 occurred
void deleteTrashEntry(long classPK)
throws PortalException,
SystemException
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 occurred
void deleteTrashEntry(long classPK,
boolean checkPermission)
throws PortalException,
SystemException
classPK - the primary key of the model entity to deletecheckPermission - whether to check permission before deleting the
model entity
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurredString getClassName()
ContainerModel getContainerModel(long containerModelId)
throws PortalException,
SystemException
containerModelId - the primary key of the container model
PortalException - if a container model with the primary key could
not be found
SystemException - if a system exception occurredString getContainerModelName()
List<ContainerModel> getContainerModels(long classPK,
long containerModelId,
int start,
int end)
throws PortalException,
SystemException
This method checks for the view permission when retrieving the container models.
Useful when paginating results. Returns a maximum of end -
start instances. The start and end
values are not primary keys but, rather, indexes in the result set. Thus,
0 refers to the first result in the set. Setting both
start and end to QueryUtil.ALL_POS will return the full
result set.
classPK - the primary key of a model entity the container models
must be able to containcontainerModelId - the primary key of the parent container modelstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurred
int getContainerModelsCount(long classPK,
long containerModelId)
throws PortalException,
SystemException
This method checks for the view permission when counting the container models.
classPK - the primary key of a model entity the container models
must be able to containcontainerModelId - the primary key of the parent container model
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurredString getDeleteMessage()
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.
String getRestoreLink(PortletRequest portletRequest,
long classPK)
throws PortalException,
SystemException
portletRequest - 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
String getRestoreMessage(PortletRequest portletRequest,
long classPK)
throws PortalException,
SystemException
portletRequest - 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 occurredString getRootContainerModelName()
String getSubcontainerModelName()
TrashRenderer getTrashRenderer(long classPK)
throws PortalException,
SystemException
classPK - 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
boolean hasTrashPermission(PermissionChecker permissionChecker,
long groupId,
long classPK,
String trashActionId)
throws PortalException,
SystemException
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.
permissionChecker - 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
boolean isInTrash(long classPK)
throws PortalException,
SystemException
true 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
boolean isRestorable(long classPK)
throws PortalException,
SystemException
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).
classPK - 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
TrashEntry moveTrashEntry(long classPK,
long containerModelId,
ServiceContext serviceContext)
throws PortalException,
SystemException
classPK - 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
void restoreTrashEntries(long[] classPKs)
throws PortalException,
SystemException
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
void restoreTrashEntry(long classPK)
throws PortalException,
SystemException
classPK - 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
void updateTitle(long classPK,
String title)
throws PortalException,
SystemException
EditEntryAction
before restoring the model entity via its restore rename action.
classPK - the primary key of the model entitytitle - the title to be assigned
PortalException - if a model entity with the primary key could not
be found
SystemException - if a system exception occurred
|
Liferay 6.2.0-ce-m1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||