|
Liferay 6.2-ce-ga5 | |||||||||
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
BookmarksEntryTrashHandler
DLFileEntryTrashHandler
DLFileShortcutTrashHandler
DLFolderTrashHandler
MBThreadTrashHandler
WikiNodeTrashHandler
WikiPageTrashHandler
Method Summary | |
---|---|
SystemEvent |
addDeletionSystemEvent(long userId,
long groupId,
long classPK,
String classUuid,
String referrerClassName)
|
void |
checkDuplicateEntry(long classPK,
long containerModelId,
String newName)
|
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. |
ContainerModel |
getContainerModel(long containerModelId)
Returns the container model with the primary key. |
String |
getContainerModelClassName()
Returns the parent container model's class name. |
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. |
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. |
String |
getRootContainerModelName()
Returns the name of the root container (e.g. |
String |
getSubcontainerModelName()
Returns the name of the subcontainer model (e.g. for a folder the subcontainer model name may be "subfolder"). |
String |
getSystemEventClassName()
|
String |
getTrashContainedModelName()
Returns the name of the contained model. |
int |
getTrashContainedModelsCount(long classPK)
Returns the number of model entities (excluding container model entities) that are children of the parent container model identified by the primary key. |
List<TrashRenderer> |
getTrashContainedModelTrashRenderers(long classPK,
int start,
int end)
Returns a range of all the trash renderers of model entities (excluding container models) that are children of the parent container model identified by the primary key. |
String |
getTrashContainerModelName()
Returns the name of the container model. |
int |
getTrashContainerModelsCount(long classPK)
Returns the number of container models that are children of the parent container model identified by the primary key. |
List<TrashRenderer> |
getTrashContainerModelTrashRenderers(long classPK,
int start,
int end)
Returns a range of all the trash renderers of model entities that are children of the parent container model identified by the primary key. |
TrashEntry |
getTrashEntry(long classPK)
|
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 |
isContainerModel()
Returns true if the entity is a container model. |
boolean |
isDeletable()
Returns true if the entity can be deleted from the Recycle
Bin. |
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 |
isMovable()
Returns true if the entity can be moved from one container
model (such as a folder) to another. |
boolean |
isRestorable(long classPK)
Returns true if the model entity can be restored to its
original location. |
boolean |
isTrashEntry(TrashEntry trashEntry,
ClassedModel classedModel)
|
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 |
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 title)
Updates the title of the model entity with the primary key. |
Method Detail |
---|
SystemEvent addDeletionSystemEvent(long userId, long groupId, long classPK, String classUuid, String referrerClassName) throws PortalException, SystemException
PortalException
SystemException
void checkDuplicateEntry(long classPK, long containerModelId, String newName) throws PortalException, SystemException
PortalException
SystemException
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 occurredvoid 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 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 getContainerModelClassName()
String 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 occurredint 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.
ContainerModel getParentContainerModel(long classPK) throws PortalException, SystemException
classPK
- 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 occurredContainerModel getParentContainerModel(TrashedModel trashedModel) throws PortalException, SystemException
PortalException
SystemException
List<ContainerModel> getParentContainerModels(long classPK) throws PortalException, SystemException
For 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.
classPK
- 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 occurredString getRestoreContainedModelLink(PortletRequest portletRequest, long classPK) throws PortalException, SystemException
PortalException
SystemException
String getRestoreContainerModelLink(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 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()
String getSystemEventClassName()
String getTrashContainedModelName()
For example, "files" may be the model name for a folder and "pages" may be the model name for a wiki node.
int getTrashContainedModelsCount(long classPK) throws PortalException, SystemException
For example, for a folder with subfolders and documents, the number of documents (excluding those explicitely moved to the recycle bin) is returned.
classPK
- the primary key of a container model
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredList<TrashRenderer> getTrashContainedModelTrashRenderers(long classPK, int start, int end) throws PortalException, SystemException
For example, for a folder with subfolders and documents, a range of all the trash renderers of documents (excluding those explicitly moved to the recycle bin) is returned.
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 container modelstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredString getTrashContainerModelName()
For example, "folder" may be the container model name for a file entry.
int getTrashContainerModelsCount(long classPK) throws PortalException, SystemException
For example, for a folder with subfolders and documents, the number of folders (excluding those explicitly moved to the recycle bin) is returned.
classPK
- the primary key of a container model
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredList<TrashRenderer> getTrashContainerModelTrashRenderers(long classPK, int start, int end) throws PortalException, SystemException
For example, for a folder with subfolders and documents, the range of renderers representing folders (excluding those explicitly moved to the recycle bin) is returned.
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 container modelstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredTrashEntry getTrashEntry(long classPK) throws PortalException, SystemException
PortalException
SystemException
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 occurredboolean 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 occurredboolean isContainerModel()
true
if the entity is a container model.
true
if the entity is a container model;
false
otherwiseboolean isDeletable()
true
if the entity can be deleted from the Recycle
Bin.
true
if the entity can be deleted from the Recycle
Bin.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 occurredboolean isInTrashContainer(long classPK) throws PortalException, SystemException
true
if the model entity with the primary key is in
a container that is in the Recycle Bin.
classPK
- 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 occurredboolean isMovable()
true
if the entity can be moved from one container
model (such as a folder) to another.
true
if the entity can be moved from one container
model to another; false
otherwiseboolean 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 occurredboolean isTrashEntry(TrashEntry trashEntry, ClassedModel classedModel)
void moveEntry(long userId, long classPK, long containerModelId, ServiceContext serviceContext) throws PortalException, SystemException
userId
- 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 occurredvoid moveTrashEntry(long userId, long classPK, long containerModelId, ServiceContext serviceContext) throws PortalException, SystemException
userId
- 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 occurredvoid restoreRelatedTrashEntry(String className, long classPK) throws PortalException, SystemException
WikiPageTrashHandler.restoreRelatedTrashEntry(
String, long)
restores the attachment related to the wiki page with the
class name and class PK.
className
- 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 occurredvoid restoreTrashEntry(long userId, long classPK) throws PortalException, SystemException
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 occurredvoid 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-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |