org.exoplatform.services.cms.documents

Interface TrashService

All Known Implementing Classes:

TrashServiceImpl

public interface TrashService

This service used to move documents to trash foder or restore

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXO_RESTORE_LOCATION
static String	RESTORE_PATH
static String	RESTORE_WORKSPACE
static String	TRASH_ID

Method Summary

Modifier and Type	Method and Description
List<javax.jcr.Node>	getAllNodeInTrash(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Get all nodes in trash location
List<javax.jcr.Node>	getAllNodeInTrashByUser(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider, String userName) Get all nodes by user in trash location
javax.jcr.Node	getNodeByTrashId(String trashId) Get Node in trash folder by trashId
javax.jcr.Node	getTrashHomeNode() Get the trash hone's node
boolean	isInTrash(javax.jcr.Node node) Check whether a given node is in Trash or not
String	moveToTrash(javax.jcr.Node node, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Move node to trash location
String	moveToTrash(javax.jcr.Node node, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider, int deep) Move node to trash location with deep
void	removeRelations(javax.jcr.Node node, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Removes all 'relationable' property of nodes that have relation to this node
void	restoreFromTrash(String trashNodePath, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Restore node from trash

Field Detail

EXO_RESTORE_LOCATION

static final String EXO_RESTORE_LOCATION

See Also:

Constant Field Values

RESTORE_PATH

static final String RESTORE_PATH

See Also:

Constant Field Values

RESTORE_WORKSPACE

static final String RESTORE_WORKSPACE

See Also:

Constant Field Values

TRASH_ID

static final String TRASH_ID

See Also:

Constant Field Values

Method Detail

moveToTrash

String moveToTrash(javax.jcr.Node node,
                   org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
            throws Exception

Move node to trash location

Parameters:

node - Node will be moved to trash

sessionProvider - User session provider which will be used to get session

Returns:

-1: move failed. trashId if moved succesfully

Throws:

Exception

moveToTrash

String moveToTrash(javax.jcr.Node node,
                   org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider,
                   int deep)
            throws Exception

Move node to trash location with deep

Parameters:

node -

sessionProvider -

deep -

Returns:

-1: move failed. trashId if moved succesfully

Throws:

Exception

restoreFromTrash

void restoreFromTrash(String trashNodePath,
                      org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
               throws Exception

Restore node from trash

Parameters:

trashNodePath - The path.

sessionProvider - The session provider.

Throws:

Exception

getAllNodeInTrash

List<javax.jcr.Node> getAllNodeInTrash(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
                                throws Exception

Get all nodes in trash location

Parameters:

sessionProvider -

Returns:

All nodes in trash

Throws:

Exception

getAllNodeInTrashByUser

List<javax.jcr.Node> getAllNodeInTrashByUser(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider,
                                             String userName)
                                      throws Exception

Get all nodes by user in trash location

Parameters:

sessionProvider -

userName -

Returns:

all node in trash which moved by user

Throws:

Exception

removeRelations

void removeRelations(javax.jcr.Node node,
                     org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
              throws Exception

Removes all 'relationable' property of nodes that have relation to this node

Parameters:

node -

sessionProvider -

Throws:

Exception

isInTrash

boolean isInTrash(javax.jcr.Node node)
           throws javax.jcr.RepositoryException

Check whether a given node is in Trash or not

Parameters:

node - a specify node

Returns:

true if node is in Trash, false otherwise.

Throws:

javax.jcr.RepositoryException

getTrashHomeNode

javax.jcr.Node getTrashHomeNode()

Get the trash hone's node

Returns:

Node the node of trash home

getNodeByTrashId

javax.jcr.Node getNodeByTrashId(String trashId)
                         throws javax.jcr.query.InvalidQueryException,
                                javax.jcr.RepositoryException

Get Node in trash folder by trashId

Parameters:

trashId - ID of node will return

Returns:

Node in trash folder with thrashId, null if thrashId doesn't exist in trash folder

Throws:

javax.jcr.query.InvalidQueryException

javax.jcr.RepositoryException