org.alfresco.rest.workflow.api.processes

Class ProcessVariablesRelation

java.lang.Object

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

All Implemented Interfaces:

RelationshipResourceAction.Create, RelationshipResourceAction.Delete, RelationshipResourceAction.Read, RelationshipResourceAction.Update, ResourceAction

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Processes	processes

Constructor Summary

Constructors

Constructor and Description
ProcessVariablesRelation()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	create(java.lang.String processId, java.util.List variables, Parameters parameters) Creates or updates multiple variables.
void	delete(java.lang.String processId, java.lang.String id, Parameters parameters) Delete a variable.
CollectionWithPagingInfo	readAll(java.lang.String processId, Parameters parameters) List the variables.
void	setProcesses(Processes processes)
Variable	update(java.lang.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 Detail

processes

protected Processes processes

Constructor Detail

ProcessVariablesRelation

public ProcessVariablesRelation()

Method Detail

setProcesses

public void setProcesses(Processes processes)

readAll

public CollectionWithPagingInfo readAll(java.lang.String processId,
                               Parameters parameters)

List the variables.

Specified by:

readAll in interface RelationshipResourceAction.Read

Parameters:

processId - Entity resource context for this relationship

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

Returns:

create

public java.util.List create(java.lang.String processId,
                    java.util.List 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

update

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

delete

public void delete(java.lang.String processId,
          java.lang.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