Package org.alfresco.rest.workflow.api.processes

Class ProcessVariablesRelation

java.lang.Object

org.alfresco.rest.workflow.api.processes.ProcessVariablesRelation

All Implemented Interfaces:

RelationshipResourceAction.Create<Variable>, RelationshipResourceAction.Delete, RelationshipResourceAction.Read<Variable>, RelationshipResourceAction.Update<Variable>, ResourceAction

@RelationshipResource(name="variables",
                      entityResource=ProcessesRestEntityResource.class,
                      title="Variables for the current process")
public class ProcessVariablesRelation
extends Object
implements RelationshipResourceAction.Read<Variable>, RelationshipResourceAction.Create<Variable>, RelationshipResourceAction.Update<Variable>, RelationshipResourceAction.Delete

Author:

Tijs Rademakers

Field Summary

Fields

Modifier and Type	Field	Description
protected Processes	processes

Constructor Summary

Constructors

Constructor	Description
ProcessVariablesRelation()

Method Summary

Modifier and Type	Method	Description
List<Variable>	create(String processId, List<Variable> variables, Parameters parameters)	Creates or updates multiple variables.
void	delete(String processId, String id, Parameters parameters)	Delete a variable.
CollectionWithPagingInfo<Variable>	readAll(String processId, Parameters parameters)	List the variables.
void	setProcesses(Processes processes)
Variable	update(String processId, Variable entity, Parameters parameters)	Update a variable.

Methods inherited from class java.lang.Object

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

Field Details

processes

protected Processes processes

Constructor Details

ProcessVariablesRelation

public ProcessVariablesRelation()

Method Details

setProcesses

public void setProcesses(Processes processes)

readAll

public CollectionWithPagingInfo<Variable> readAll(String processId,
 Parameters parameters)

List the variables.

Specified by:

readAll in interface RelationshipResourceAction.Read<Variable>

Parameters:

processId - Entity resource context for this relationship

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

create

public List<Variable> create(String processId,
 List<Variable> variables,
 Parameters parameters)

Creates or updates multiple variables. If the variable name doesn't exist yet it will be created

Specified by:

create in interface RelationshipResourceAction.Create<Variable>

update

public Variable update(String processId,
 Variable entity,
 Parameters parameters)

Update a variable. If the variable name doesn't exist yet it will be created

Specified by:

update in interface RelationshipResourceAction.Update<Variable>

delete

public void delete(String processId,
 String id,
 Parameters parameters)

Delete a variable. If the variable name doesn't exist the delete call throws an exception.

Specified by:

delete in interface RelationshipResourceAction.Delete