Liferay 6.2.0-ce-m3

com.liferay.portlet.wiki.trash
Class WikiNodeTrashHandler

java.lang.Object
  extended by com.liferay.portal.kernel.trash.BaseTrashHandler
      extended by com.liferay.portlet.wiki.trash.WikiNodeTrashHandler
All Implemented Interfaces:
TrashHandler

public class WikiNodeTrashHandler
extends BaseTrashHandler

Implements trash handling for the wiki node entity.


Field Summary
static String CLASS_NAME
           
 
Constructor Summary
WikiNodeTrashHandler()
           
 
Method Summary
 void checkDuplicateTrashEntry(TrashEntry trashEntry, long containerModelId, String newName)
          Checks if a duplicate trash entry already exists in the destination container.
 void deleteTrashEntries(long[] classPKs, boolean checkPermission)
          Deletes all the model entities with the primary keys, optionally checking permission before deleting each model entity.
 String getClassName()
          Returns the class name handled by this trash handler.
 String getRestoreLink(PortletRequest portletRequest, long classPK)
          Returns the link to the location to which the trash entry was restored.
 String getRestoreMessage(PortletRequest portletRequest, long classPK)
          Returns the message describing the location to which the trash entry was restored.
 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.
 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 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.
 void restoreTrashEntries(long[] classPKs)
          Restores all the model entities with the primary keys.
 void updateTitle(long classPK, String name)
          Updates the title of the trash entry with the primary key.
 
Methods inherited from class com.liferay.portal.kernel.trash.BaseTrashHandler
deleteTrashEntries, deleteTrashEntry, deleteTrashEntry, getAssetRendererFactory, getContainerModel, getContainerModelClassName, getContainerModelName, getContainerModels, getContainerModelsCount, getDeleteMessage, getParentContainerModel, getParentContainerModels, getRootContainerModelName, getSubcontainerModelName, getTrashContainerModelName, getTrashContainerModelsCount, getTrashContainerModelTrashRenderers, hasTrashPermission, isInTrashContainer, isMovable, isRestorable, moveEntry, moveTrashEntry, restoreTrashEntry
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_NAME

public static final String CLASS_NAME
Constructor Detail

WikiNodeTrashHandler

public WikiNodeTrashHandler()
Method Detail

checkDuplicateTrashEntry

public void checkDuplicateTrashEntry(TrashEntry trashEntry,
                                     long containerModelId,
                                     String newName)
                              throws PortalException,
                                     SystemException
Description copied from class: BaseTrashHandler
Checks if a duplicate trash entry already exists in the destination container.

This method is used to check for duplicates when a trash entry is being restored or moved out of the Recycle Bin.

Specified by:
checkDuplicateTrashEntry in interface TrashHandler
Overrides:
checkDuplicateTrashEntry in class BaseTrashHandler
Parameters:
trashEntry - the trash entry to check
containerModelId - 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)
Throws:
PortalException - if a duplicate trash entry already existed in the destination container
SystemException - if a system exception occurred

deleteTrashEntries

public void deleteTrashEntries(long[] classPKs,
                               boolean checkPermission)
                        throws PortalException,
                               SystemException
Description copied from interface: TrashHandler
Deletes all the model entities with the primary keys, optionally checking permission before deleting each model entity.

Parameters:
classPKs - the primary keys of the model entities to delete
checkPermission - whether to check permission before deleting each model entity
Throws:
PortalException - if any one of the model entities could not be found
SystemException - if a system exception occurred

getClassName

public String getClassName()
Description copied from interface: TrashHandler
Returns the class name handled by this trash handler.

Returns:
the class name handled by this trash handler

getRestoreLink

public String getRestoreLink(PortletRequest portletRequest,
                             long classPK)
                      throws PortalException,
                             SystemException
Description copied from class: BaseTrashHandler
Returns the link to the location to which the trash entry was restored.

Specified by:
getRestoreLink in interface TrashHandler
Overrides:
getRestoreLink in class BaseTrashHandler
Parameters:
portletRequest - the portlet request
classPK - the primary key of the restored trash entry
Returns:
the restore link
Throws:
PortalException - if a trash entry with the primary key could not be found
SystemException - if a system exception occurred

getRestoreMessage

public String getRestoreMessage(PortletRequest portletRequest,
                                long classPK)
Description copied from class: BaseTrashHandler
Returns the message describing the location to which the trash entry was restored.

Specified by:
getRestoreMessage in interface TrashHandler
Overrides:
getRestoreMessage in class BaseTrashHandler
Parameters:
portletRequest - the portlet request
classPK - the primary key of the restored trash entry
Returns:
the restore message

getTrashContainedModelName

public String getTrashContainedModelName()
Description copied from interface: TrashHandler
Returns the name of the contained model.

For example, "files" may be the model name for a folder and "pages" may be the model name for a wiki node.

Specified by:
getTrashContainedModelName in interface TrashHandler
Overrides:
getTrashContainedModelName in class BaseTrashHandler
Returns:
the name of the contained model

getTrashContainedModelsCount

public int getTrashContainedModelsCount(long classPK)
                                 throws SystemException
Description copied from interface: TrashHandler
Returns the number of model entities (excluding container model entities) that are children of the parent container model identified by the primary key.

For example, for a folder with subfolders and documents, the number of documents (excluding those explicitely moved to the recycle bin) is returned.

Specified by:
getTrashContainedModelsCount in interface TrashHandler
Overrides:
getTrashContainedModelsCount in class BaseTrashHandler
Parameters:
classPK - the primary key of a container model
Returns:
the number of model entities that are children of the parent container model identified by the primary key
Throws:
SystemException - if a system exception occurred

getTrashContainedModelTrashRenderers

public List<TrashRenderer> getTrashContainedModelTrashRenderers(long classPK,
                                                                int start,
                                                                int end)
                                                         throws PortalException,
                                                                SystemException
Description copied from interface: TrashHandler
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.

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.

Specified by:
getTrashContainedModelTrashRenderers in interface TrashHandler
Overrides:
getTrashContainedModelTrashRenderers in class BaseTrashHandler
Parameters:
classPK - the primary key of a container model
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
Returns:
the range of trash renderers of model entities (excluding container models) that are children of the parent container model identified by the primary key
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

getTrashRenderer

public TrashRenderer getTrashRenderer(long classPK)
                               throws PortalException,
                                      SystemException
Description copied from interface: TrashHandler
Returns the trash renderer associated to the model entity with the primary key.

Specified by:
getTrashRenderer in interface TrashHandler
Overrides:
getTrashRenderer in class BaseTrashHandler
Parameters:
classPK - the primary key of the model entity
Returns:
the trash renderer associated to the model entity
Throws:
PortalException - if a model entity with the primary key could not be found
SystemException - if a system exception occurred

isContainerModel

public boolean isContainerModel()
Description copied from interface: TrashHandler
Returns true if the entity is a container model.

Specified by:
isContainerModel in interface TrashHandler
Overrides:
isContainerModel in class BaseTrashHandler
Returns:
true if the entity is a container model; false otherwise

isInTrash

public boolean isInTrash(long classPK)
                  throws PortalException,
                         SystemException
Description copied from interface: TrashHandler
Returns true if the model entity with the primary key is in the Recycle Bin.

Parameters:
classPK - the primary key of the model entity
Returns:
true if the model entity is in the Recycle Bin; false otherwise
Throws:
PortalException - if a model entity with the primary key could not be found in the portal
SystemException - if a system exception occurred

restoreTrashEntries

public void restoreTrashEntries(long[] classPKs)
                         throws PortalException,
                                SystemException
Description copied from interface: TrashHandler
Restores all the model entities with the primary keys.

Parameters:
classPKs - the primary keys of the model entities to restore
Throws:
PortalException - if any one of the model entities could not be found
SystemException - if a system exception occurred

updateTitle

public void updateTitle(long classPK,
                        String name)
                 throws PortalException,
                        SystemException
Description copied from class: BaseTrashHandler
Updates the title of the trash entry with the primary key. This method is called by EditEntryAction before restoring the trash entry via its restore rename action.

Specified by:
updateTitle in interface TrashHandler
Overrides:
updateTitle in class BaseTrashHandler
Parameters:
classPK - the primary key of the trash entry
name - the title to be assigned
Throws:
PortalException - if a trash entry with the primary key could not be found
SystemException - if a system exception occurred

hasPermission

protected boolean hasPermission(PermissionChecker permissionChecker,
                                long classPK,
                                String actionId)
                         throws PortalException,
                                SystemException
Specified by:
hasPermission in class BaseTrashHandler
Throws:
PortalException
SystemException

Liferay 6.2.0-ce-m3