com.liferay.journal.trash

Class JournalArticleTrashHandler

java.lang.Object

com.liferay.portal.kernel.trash.BaseTrashHandler

com.liferay.journal.trash.JournalBaseTrashHandler

com.liferay.journal.trash.JournalArticleTrashHandler

All Implemented Interfaces:

TrashHandler

public class JournalArticleTrashHandler
extends JournalBaseTrashHandler

Implements trash handling for the journal article entity.

Constructor Summary

Constructors

Constructor and Description
JournalArticleTrashHandler()

Method Summary

Modifier and Type	Method and Description
protected void	checkDuplicateEntry(long classPK, long trashEntryId, java.lang.String originalTitle, java.lang.String newName)
protected void	checkRestorableEntry(long classPK, long trashEntryId, long containerModelId, java.lang.String originalTitle, java.lang.String newName)
void	checkRestorableEntry(long classPK, long containerModelId, java.lang.String newName)
void	checkRestorableEntry(TrashEntry trashEntry, long containerModelId, java.lang.String newName) Checks if a duplicate trash entry already exists in the destination container.
protected void	checkValidContainer(long classPK, long containerModelId)
void	deleteTrashEntry(long classPK) Deletes the model entity with the primary key.
java.lang.String	getClassName() Returns the class name handled by this trash handler.
Filter	getExcludeFilter(SearchContext searchContext)
protected long	getGroupId(long classPK)
ContainerModel	getParentContainerModel(long classPK) Returns the parent container model of the model entity with the primary key.
ContainerModel	getParentContainerModel(TrashedModel trashedModel)
java.lang.String	getRestoreContainerModelLink(javax.portlet.PortletRequest portletRequest, long classPK) Returns the link to the location to which the model entity was restored.
java.lang.String	getRestoreMessage(javax.portlet.PortletRequest portletRequest, long classPK) Returns the message describing the location to which the model entity was restored.
TrashEntry	getTrashEntry(long classPK)
TrashRenderer	getTrashRenderer(long classPK) Returns the trash renderer associated to the model entity with the primary key.
protected boolean	hasPermission(PermissionChecker permissionChecker, long classPK, java.lang.String actionId)
boolean	hasTrashPermission(PermissionChecker permissionChecker, long groupId, long classPK, java.lang.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	isInTrashContainer(long classPK) Returns true if the model entity with the primary key is in a container that is in the Recycle Bin.
boolean	isRestorable(long classPK) Returns true if the model entity can be restored to its original location.
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 containerId, 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	restoreTrashEntry(long userId, long classPK) Restores the model entity with the primary key.
protected void	setDDMStructureLocalService(DDMStructureLocalService ddmStructureLocalService)
protected void	setJournalArticleLocalService(JournalArticleLocalService journalArticleLocalService)
protected void	setJournalArticleResourceLocalService(JournalArticleResourceLocalService journalArticleResourceLocalService)
protected void	setJournalFolderLocalService(JournalFolderLocalService journalFolderLocalService)
void	updateTitle(long classPK, java.lang.String name) Updates the title of the model entity with the primary key.

Methods inherited from class com.liferay.journal.trash.JournalBaseTrashHandler

getContainerModel, getContainerModelClassName, getContainerModelName, getContainerModels, getContainerModelsCount, getParentContainerModels, getRootContainerModelName, getSubcontainerModelName, getTrashContainedModelName, getTrashContainedModelsCount, getTrashContainedModelTrashRenderers, getTrashContainerModelName, getTrashContainerModelsCount, getTrashContainerModelTrashRenderers, getTrashModelsCount, getTrashModelTrashRenderers, isMovable

Methods inherited from class com.liferay.portal.kernel.trash.BaseTrashHandler

addDeletionSystemEvent, checkDuplicateEntry, checkDuplicateTrashEntry, getAssetRendererFactory, getContainerModelClassName, getDeleteMessage, getDestinationContainerModelId, getExcludeQuery, getRestoreContainedModelLink, getSystemEventClassName, isContainerModel, isDeletable, restoreRelatedTrashEntry

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JournalArticleTrashHandler

public JournalArticleTrashHandler()

Method Detail

checkRestorableEntry

public void checkRestorableEntry(long classPK,
                                 long containerModelId,
                                 java.lang.String newName)
                          throws PortalException

Specified by:

checkRestorableEntry in interface TrashHandler

Overrides:

checkRestorableEntry in class BaseTrashHandler

Throws:

PortalException

checkRestorableEntry

public void checkRestorableEntry(TrashEntry trashEntry,
                                 long containerModelId,
                                 java.lang.String newName)
                          throws PortalException

Description copied from interface: TrashHandler

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:

checkRestorableEntry in interface TrashHandler

Overrides:

checkRestorableEntry 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

deleteTrashEntry

public void deleteTrashEntry(long classPK)
                      throws PortalException

Description copied from interface: TrashHandler

Deletes the model entity with the primary key.

Parameters:

classPK - the primary key of the model entity to delete

Throws:

PortalException

getClassName

public java.lang.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

getExcludeFilter

public Filter getExcludeFilter(SearchContext searchContext)

Specified by:

getExcludeFilter in interface TrashHandler

Overrides:

getExcludeFilter in class BaseTrashHandler

getParentContainerModel

public ContainerModel getParentContainerModel(long classPK)
                                       throws PortalException

Description copied from interface: TrashHandler

Returns the parent container model of the model entity with the primary key.

Specified by:

getParentContainerModel in interface TrashHandler

Overrides:

getParentContainerModel in class BaseTrashHandler

Parameters:

classPK - the primary key of a model entity the container models must be able to contain

Returns:

the parent container model of the model entity with the primary key

Throws:

PortalException

getParentContainerModel

public ContainerModel getParentContainerModel(TrashedModel trashedModel)
                                       throws PortalException

Specified by:

getParentContainerModel in interface TrashHandler

Overrides:

getParentContainerModel in class BaseTrashHandler

Throws:

PortalException

getRestoreContainerModelLink

public java.lang.String getRestoreContainerModelLink(javax.portlet.PortletRequest portletRequest,
                                                     long classPK)
                                              throws PortalException

Description copied from interface: TrashHandler

Returns the link to the location to which the model entity was restored.

Specified by:

getRestoreContainerModelLink in interface TrashHandler

Overrides:

getRestoreContainerModelLink in class BaseTrashHandler

Parameters:

portletRequest - the portlet request

classPK - the primary key of the restored model entity

Returns:

the restore link

Throws:

PortalException

getRestoreMessage

public java.lang.String getRestoreMessage(javax.portlet.PortletRequest portletRequest,
                                          long classPK)
                                   throws PortalException

Description copied from interface: TrashHandler

Returns the message describing the location to which the model entity 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 model entity

Returns:

the restore message

Throws:

PortalException

getTrashEntry

public TrashEntry getTrashEntry(long classPK)
                         throws PortalException

Specified by:

getTrashEntry in interface TrashHandler

Overrides:

getTrashEntry in class BaseTrashHandler

Throws:

PortalException

getTrashRenderer

public TrashRenderer getTrashRenderer(long classPK)
                               throws PortalException

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

hasTrashPermission

public boolean hasTrashPermission(PermissionChecker permissionChecker,
                                  long groupId,
                                  long classPK,
                                  java.lang.String trashActionId)
                           throws PortalException

Description copied from interface: TrashHandler

Returns 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.

Specified by:

hasTrashPermission in interface TrashHandler

Overrides:

hasTrashPermission in class BaseTrashHandler

Parameters:

permissionChecker - the permission checker

groupId - the primary key of the group

classPK - the primary key of the model entity

trashActionId - the trash action permission to check

Returns:

true if the user has the required permission; false otherwise

Throws:

PortalException

isInTrash

public boolean isInTrash(long classPK)
                  throws PortalException

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

isInTrashContainer

public boolean isInTrashContainer(long classPK)
                           throws PortalException

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

isRestorable

public boolean isRestorable(long classPK)
                     throws PortalException

Description copied from interface: TrashHandler

Returns 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).

Specified by:

isRestorable in interface TrashHandler

Overrides:

isRestorable in class BaseTrashHandler

Parameters:

classPK - the primary key of the model entity

Returns:

true if the model entity can be restored to its original location; false otherwise

Throws:

PortalException

moveEntry

public void moveEntry(long userId,
                      long classPK,
                      long containerModelId,
                      ServiceContext serviceContext)
               throws PortalException

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

Parameters:

userId - the user ID

classPK - the primary key of the model entity

containerModelId - the primary key of the destination container model

serviceContext - the service context to be applied

Throws:

PortalException

moveTrashEntry

public void moveTrashEntry(long userId,
                           long classPK,
                           long containerId,
                           ServiceContext serviceContext)
                    throws PortalException

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:

userId - the user ID

classPK - the primary key of the model entity

containerId - the primary key of the destination container model

serviceContext - the service context to be applied

Throws:

PortalException

restoreTrashEntry

public void restoreTrashEntry(long userId,
                              long classPK)
                       throws PortalException

Description copied from interface: TrashHandler

Restores the model entity with the primary key.

Parameters:

userId - the user ID

classPK - the primary key of the model entity to restore

Throws:

PortalException

updateTitle

public void updateTitle(long classPK,
                        java.lang.String name)
                 throws PortalException

Description copied from interface: TrashHandler

Updates the title of the model entity with the primary key. This method is called by com.liferay.portlet.trash.action.EditEntryAction before restoring the model entity via its restore rename action.

Specified by:

updateTitle in interface TrashHandler

Overrides:

updateTitle in class BaseTrashHandler

Parameters:

classPK - the primary key of the model entity

name - the title to be assigned

Throws:

PortalException

checkDuplicateEntry

protected void checkDuplicateEntry(long classPK,
                                   long trashEntryId,
                                   java.lang.String originalTitle,
                                   java.lang.String newName)
                            throws PortalException

Throws:

PortalException

checkRestorableEntry

protected void checkRestorableEntry(long classPK,
                                    long trashEntryId,
                                    long containerModelId,
                                    java.lang.String originalTitle,
                                    java.lang.String newName)
                             throws PortalException

Throws:

PortalException

checkValidContainer

protected void checkValidContainer(long classPK,
                                   long containerModelId)
                            throws PortalException

Throws:

PortalException

getGroupId

protected long getGroupId(long classPK)
                   throws PortalException

Specified by:

getGroupId in class JournalBaseTrashHandler

Throws:

PortalException

hasPermission

protected boolean hasPermission(PermissionChecker permissionChecker,
                                long classPK,
                                java.lang.String actionId)
                         throws PortalException

Specified by:

hasPermission in class BaseTrashHandler

Throws:

PortalException

setDDMStructureLocalService

protected void setDDMStructureLocalService(DDMStructureLocalService ddmStructureLocalService)

setJournalArticleLocalService

protected void setJournalArticleLocalService(JournalArticleLocalService journalArticleLocalService)

setJournalArticleResourceLocalService

protected void setJournalArticleResourceLocalService(JournalArticleResourceLocalService journalArticleResourceLocalService)

setJournalFolderLocalService

protected void setJournalFolderLocalService(JournalFolderLocalService journalFolderLocalService)