org.syrup
Interface Task

All Known Subinterfaces:
PTask, PTaskTemplate
All Known Implementing Classes:
PTaskImpl, PTaskTemplateImpl, TaskImpl

public interface Task

Specifies a task with a name, description, function, environment, type and parameter.

Author:
Robbert van Dalen

Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.String description()
          Returns the defined description of a Task.
 java.lang.String environment()
          Returns the logical environment of the Task.
 java.lang.String functionClass()
          Returns the classname of the Function.
 java.lang.String name()
          Returns the defined name of a Task.
 boolean orType()
          Returns true if the type is OR.
 java.lang.String parameter()
          Returns the static parameter to parameterize the Task.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

name

public java.lang.String name()
Returns the defined name of a Task. All Tasks that are part of the same Workflow (share the same parent) should have an unique name.

Returns:
The defined name.

description

public java.lang.String description()
Returns the defined description of a Task. This can be used as an annotation for the execution of a Task, or as a match criterium to fetch Tasks from a WorkSpace.

Returns:
The defined description.

functionClass

public java.lang.String functionClass()
Returns the classname of the Function.

Returns:
The Function's classname.

environment

public java.lang.String environment()
Returns the logical environment of the Task.

Returns:
The logical environment.

orType

public boolean orType()
Returns true if the type is OR. Returns false if the type is AND. OR Tasks are marked for execution if one of the inputs is full. AND Tasks are marked for execution if both inputs are full.

Returns:
the type.

parameter

public java.lang.String parameter()
Returns the static parameter to parameterize the Task.

Returns:
The static parameter.