uk.org.ogsadai.client.toolkit.activity
Interface ActivityInputParameter

All Known Subinterfaces:

ActivityInputParameterInternal

All Known Implementing Classes:

ActivityInputParameterImpl

public interface ActivityInputParameter

Represents details of an activity input parameter.

Each activity can have a number of inputs and outputs. Inputs must be connected to the outputs from other activities.

Author:

The OGSA-DAI Project Team

getOutputName

public java.lang.String getOutputName()

Gets the name of the activity output that is the input to this parameter.

Note that this is the name of the output not the name of the an output parameter. Multiple activities may have outputs that share the same parameter name (for example 'QueryResult') but each output for each activity will have a unique output name.

Returns:

name of the output that is the input to this parameter, or null if the output has not yet been specified.

getName

public java.lang.String getName()

Gets the name of the input parameter.

This name has no real internal purpose. It is intended purely as a label that can be attached to the input if the inputs are to be displayed to the user.

Returns:

the input parameter name.

isOptional

public boolean isOptional()

Gets whether or not this input parameter can be regarded as optional or not.

Returns:

true is the input is optional, false otherwise.

toString

public java.lang.String toString()

Returns a brief description of this activity input parameter. The exact details are subject to change but at present the format is:
[ActivityInputParameter: name = 'query' output = 'f6373a5f' optional = false]

Overrides:

toString in class java.lang.Object

Returns:

brief description of this activity input parameter.