org.alfresco.rest.api.trashcan

Class TrashcanEntityResource

java.lang.Object

org.alfresco.rest.api.trashcan.TrashcanEntityResource

All Implemented Interfaces:

BinaryResourceAction.Read, EntityResourceAction.Delete, EntityResourceAction.Read<Node>, EntityResourceAction.ReadById<Node>, ResourceAction

@EntityResource(name="deleted-nodes",
                title="Deleted Nodes")
public class TrashcanEntityResource
extends Object
implements EntityResourceAction.ReadById<Node>, EntityResourceAction.Read<Node>, EntityResourceAction.Delete, BinaryResourceAction.Read

An implementation of an Entity Resource for handling archived content

Author:

Gethin James

Constructor Summary

Constructors

Constructor and Description
TrashcanEntityResource()

Method Summary

Modifier and Type	Method and Description
void	delete(String nodeId, Parameters parameters)
CollectionWithPagingInfo<Node>	readAll(Parameters params) Reads all the entries from the collection.
Node	readById(String nodeId, Parameters parameters)
BinaryResource	readProperty(String nodeId, Parameters parameters) Retrieves a binary property by returning a BinaryResource object.
Node	restoreDeletedNode(String nodeId, NodeTargetAssoc nodeTargetAssoc, Parameters parameters, WithResponse withResponse)
void	setDeletedNodes(DeletedNodes deletedNodes)

Methods inherited from class java.lang.Object

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

Constructor Detail

TrashcanEntityResource

public TrashcanEntityResource()

Method Detail

setDeletedNodes

public void setDeletedNodes(DeletedNodes deletedNodes)

readAll

public CollectionWithPagingInfo<Node> readAll(Parameters params)

Description copied from interface: EntityResourceAction.Read

Reads all the entries from the collection. Paging information is provided.

Specified by:

readAll in interface EntityResourceAction.Read<Node>

Parameters:

params - - will never be null and will have the PAGING default values

readById

public Node readById(String nodeId,
                     Parameters parameters)
              throws EntityNotFoundException

Specified by:

readById in interface EntityResourceAction.ReadById<Node>

Throws:

EntityNotFoundException

restoreDeletedNode

public Node restoreDeletedNode(String nodeId,
                               NodeTargetAssoc nodeTargetAssoc,
                               Parameters parameters,
                               WithResponse withResponse)

readProperty

public BinaryResource readProperty(String nodeId,
                                   Parameters parameters)

Description copied from interface: BinaryResourceAction.Read

Retrieves a binary property by returning a BinaryResource object. The specific property is specified in the Parameters object. See Parameters.hasBinaryProperty(String) or Parameters.getBinaryProperty()

Specified by:

readProperty in interface BinaryResourceAction.Read

Parameters:

nodeId - unique id

parameters - Parameters

Returns:

BinaryResource - Either FileBinaryResource or NodeBinaryResource

delete

public void delete(String nodeId,
                   Parameters parameters)

Specified by:

delete in interface EntityResourceAction.Delete