org.alfresco.rest.workflow.api.tasks

Class TaskVariablesRelation

java.lang.Object

org.alfresco.rest.workflow.api.tasks.TaskVariablesRelation

All Implemented Interfaces:

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

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

Constructor Summary

Constructors

Constructor and Description
TaskVariablesRelation()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	create(java.lang.String taskId, java.util.List variables, Parameters parameters) Creates or updates multiple task variables.
void	delete(java.lang.String entityResourceId, java.lang.String id, Parameters parameters) Delete a task variable.
CollectionWithPagingInfo	readAll(java.lang.String taskId, Parameters parameters) List the tasks variables.
void	setTasks(Tasks tasks)
TaskVariable	update(java.lang.String taskId, TaskVariable entity, Parameters parameters) Update a task variable.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskVariablesRelation

public TaskVariablesRelation()

Method Detail

setTasks

public void setTasks(Tasks tasks)

readAll

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

List the tasks variables.

Specified by:

readAll in interface RelationshipResourceAction.Read

Parameters:

taskId - Entity resource context for this relationship

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

Returns:

See Also:

RelationshipResourceAction.Read.readAll(java.lang.String, org.alfresco.rest.framework.resource.parameters.Parameters)

create

public java.util.List create(java.lang.String taskId,
                    java.util.List variables,
                    Parameters parameters)

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

Specified by:

create in interface RelationshipResourceAction.Create

update

public TaskVariable update(java.lang.String taskId,
                  TaskVariable entity,
                  Parameters parameters)

Update a task 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 entityResourceId,
          java.lang.String id,
          Parameters parameters)

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

Specified by:

delete in interface RelationshipResourceAction.Delete