Liferay 6.2.0-ce-m3

com.liferay.portlet.messageboards.trash
Class MBThreadTrashHandler

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

public class MBThreadTrashHandler
extends BaseTrashHandler

Implements trash handling for message boards thread entity.


Field Summary
static String CLASS_NAME
           
 
Constructor Summary
MBThreadTrashHandler()
           
 
Method Summary
 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.
 List<ContainerModel> getContainerModels(long classPK, long parentContainerModelId, 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 parentContainerModelId)
          Returns the number of container models that are children of the parent container model identified by the container model ID.
 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.
 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 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.
 void moveEntry(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 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.
 
Methods inherited from class com.liferay.portal.kernel.trash.BaseTrashHandler
checkDuplicateTrashEntry, deleteTrashEntries, deleteTrashEntry, deleteTrashEntry, getAssetRendererFactory, getContainerModel, getContainerModelClassName, getContainerModelName, getDeleteMessage, getParentContainerModel, getParentContainerModels, getRootContainerModelName, getSubcontainerModelName, getTrashContainedModelName, getTrashContainedModelsCount, getTrashContainedModelTrashRenderers, getTrashContainerModelName, getTrashContainerModelsCount, getTrashContainerModelTrashRenderers, hasTrashPermission, isContainerModel, isRestorable, restoreTrashEntry, updateTitle
 
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

MBThreadTrashHandler

public MBThreadTrashHandler()
Method Detail

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

getContainerModels

public List<ContainerModel> getContainerModels(long classPK,
                                               long parentContainerModelId,
                                               int start,
                                               int end)
                                        throws PortalException,
                                               SystemException
Description copied from class: BaseTrashHandler
Returns a range of all the container models that are children of the parent container model identified by the container model ID. These container models must be able to contain the entity identified by the primary key.

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.

Specified by:
getContainerModels in interface TrashHandler
Overrides:
getContainerModels in class BaseTrashHandler
Parameters:
classPK - the primary key of an entity the container models must be able to contain
parentContainerModelId - the primary key of the parent 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 matching container models
Throws:
PortalException - if a trash entry with the primary key could not be found
SystemException - if a system exception occurred

getContainerModelsCount

public int getContainerModelsCount(long classPK,
                                   long parentContainerModelId)
                            throws PortalException,
                                   SystemException
Description copied from class: BaseTrashHandler
Returns the number of container models that are children of the parent container model identified by the container model ID. These container models must be able to contain the entity identified by the primary key.

This method checks for the view permission when counting the container models.

Specified by:
getContainerModelsCount in interface TrashHandler
Overrides:
getContainerModelsCount in class BaseTrashHandler
Parameters:
classPK - the primary key of an entity the container models must be able to contain
parentContainerModelId - the primary key of the parent container model
Returns:
the number of matching container models
Throws:
PortalException - if a trash entry with the primary key could not be found
SystemException - if a system exception occurred

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)
                         throws PortalException,
                                SystemException
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
Throws:
PortalException - if a trash entry with the primary key could not be found
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

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

isInTrashContainer

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

Specified by:
isInTrashContainer in interface TrashHandler
Overrides:
isInTrashContainer in class BaseTrashHandler
Parameters:
classPK - the primary key of the model entity
Returns:
true if the model entity with the primary key is in a container that 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

isMovable

public boolean isMovable()
Description copied from interface: TrashHandler
Returns true if the entity can be moved from one container model (such as a folder) to another.

Specified by:
isMovable in interface TrashHandler
Overrides:
isMovable in class BaseTrashHandler
Returns:
true if the entity can be moved from one container model to another; false otherwise

moveEntry

public void moveEntry(long classPK,
                      long containerModelId,
                      ServiceContext serviceContext)
               throws PortalException,
                      SystemException
Description copied from interface: TrashHandler
Moves the entity with the class primary key to the container model with the class primary key

Specified by:
moveEntry in interface TrashHandler
Overrides:
moveEntry in class BaseTrashHandler
Throws:
PortalException
SystemException

moveTrashEntry

public void moveTrashEntry(long classPK,
                           long containerModelId,
                           ServiceContext serviceContext)
                    throws PortalException,
                           SystemException
Description copied from interface: TrashHandler
Moves the model entity with the primary key out of the Recycle Bin to a new destination identified by the container model ID.

Specified by:
moveTrashEntry in interface TrashHandler
Overrides:
moveTrashEntry in class BaseTrashHandler
Parameters:
classPK - the primary key of the model entity
containerModelId - the primary key of the destination container model
serviceContext - the service context
Throws:
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

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

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