Package org.alfresco.rest.workflow.api.processdefinitions

Class ProcessDefinitionsRestEntityResource

java.lang.Object

org.alfresco.rest.workflow.api.processdefinitions.ProcessDefinitionsRestEntityResource

All Implemented Interfaces:

BinaryResourceAction.Read, EntityResourceAction.Read<ProcessDefinition>, EntityResourceAction.ReadById<ProcessDefinition>, ResourceAction

@EntityResource(name="process-definitions",
                title="Process definitions")
public class ProcessDefinitionsRestEntityResource
extends Object
implements EntityResourceAction.Read<ProcessDefinition>, EntityResourceAction.ReadById<ProcessDefinition>, BinaryResourceAction.Read

Constructor Summary

Constructors

Constructor	Description
ProcessDefinitionsRestEntityResource()

Method Summary

Modifier and Type	Method	Description
CollectionWithPagingInfo<ProcessDefinition>	readAll(Parameters params)	Reads all the entries from the collection.
ProcessDefinition	readById(String id, Parameters parameters)
BinaryResource	readProperty(String id, Parameters parameters)	Retrieves a binary property by returning a BinaryResource object.
void	setProcessDefinitions(ProcessDefinitions processDefinitions)

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessDefinitionsRestEntityResource

public ProcessDefinitionsRestEntityResource()

Method Details

setProcessDefinitions

public void setProcessDefinitions(ProcessDefinitions processDefinitions)

readAll

public CollectionWithPagingInfo<ProcessDefinition> 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<ProcessDefinition>

Parameters:

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

readById

public ProcessDefinition readById(String id,
 Parameters parameters)
                           throws EntityNotFoundException

Specified by:

readById in interface EntityResourceAction.ReadById<ProcessDefinition>

Throws:

EntityNotFoundException

readProperty

public BinaryResource readProperty(String id,
 Parameters parameters)
                            throws EntityNotFoundException

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:

id - unique id

parameters - Parameters

Returns:

BinaryResource - Either FileBinaryResource or NodeBinaryResource

Throws:

EntityNotFoundException