|
Liferay 6.2.0-ce-m4 | |||||||||
| 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.messageboards.trash.MBThreadTrashHandler
public class MBThreadTrashHandler
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. |
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 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 model entity was restored. |
String |
getRestoreMessage(PortletRequest portletRequest,
long classPK)
Returns the message describing the location to which the model entity 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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final String CLASS_NAME
| Constructor Detail |
|---|
public MBThreadTrashHandler()
| Method Detail |
|---|
public void deleteTrashEntries(long[] classPKs,
boolean checkPermission)
throws PortalException,
SystemException
TrashHandler
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 occurredpublic String getClassName()
TrashHandler
public String getContainerModelClassName()
TrashHandler
getContainerModelClassName in interface TrashHandlergetContainerModelClassName in class BaseTrashHandlerpublic String getContainerModelName()
TrashHandler
getContainerModelName in interface TrashHandlergetContainerModelName in class BaseTrashHandler
public List<ContainerModel> getContainerModels(long classPK,
long parentContainerModelId,
int start,
int end)
throws PortalException,
SystemException
TrashHandlerThis 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.
getContainerModels in interface TrashHandlergetContainerModels in class BaseTrashHandlerclassPK - the primary key of a model entity the container models
must be able to containparentContainerModelId - 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
public int getContainerModelsCount(long classPK,
long parentContainerModelId)
throws PortalException,
SystemException
TrashHandlerThis method checks for the view permission when counting the container models.
getContainerModelsCount in interface TrashHandlergetContainerModelsCount in class BaseTrashHandlerclassPK - the primary key of a model entity the container models
must be able to containparentContainerModelId - 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 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 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 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 occurredpublic boolean isMovable()
TrashHandlertrue if the entity can be moved from one container
model (such as a folder) to another.
isMovable in interface TrashHandlerisMovable in class BaseTrashHandlertrue if the entity can be moved from one container
model to another; false otherwise
public void moveEntry(long classPK,
long containerModelId,
ServiceContext serviceContext)
throws PortalException,
SystemException
TrashHandler
moveEntry in interface TrashHandlermoveEntry in class BaseTrashHandlerPortalException
SystemException
public void moveTrashEntry(long classPK,
long containerModelId,
ServiceContext serviceContext)
throws PortalException,
SystemException
TrashHandler
moveTrashEntry in interface TrashHandlermoveTrashEntry in class BaseTrashHandlerclassPK - 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
public void restoreTrashEntries(long[] classPKs)
throws PortalException,
SystemException
TrashHandler
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
protected boolean hasPermission(PermissionChecker permissionChecker,
long classPK,
String actionId)
throws PortalException,
SystemException
hasPermission in class BaseTrashHandlerPortalException
SystemException
|
Liferay 6.2.0-ce-m4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||