de.danet.an.workflow.api
Class FormalParameter

java.lang.Object
  de.danet.an.workflow.api.FormalParameter

All Implemented Interfaces:

java.io.Serializable

public class FormalParameter

extends java.lang.Object

implements java.io.Serializable

This class provides a description of a formal parameter as used for workflow processes and workflow applications.

See Also:

Serialized Form

Nested Class Summary

static class

FormalParameter.Mode Defines a class for representing priorities in a type save way.

Constructor Summary

FormalParameter(java.lang.String newId, java.lang.String newIndex, FormalParameter.Mode newMode, java.lang.Object newType)
Creates a new FormalParameter.

Method Summary

boolean	equals(java.lang.Object obj) Compare two formal parameter objects.
int	hashCode() Evaluate hash code.
java.lang.String	id() Return the id of the formal parameter.
java.lang.String	index() Return the index of the formal parameter.
FormalParameter.Mode	mode() Return the mode of the formal parameter.
java.lang.String	toString() Create string representation for debugging purposes.
java.lang.Object	type() Return the type of the formal parameter.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FormalParameter

public FormalParameter(java.lang.String newId,
                       java.lang.String newIndex,
                       FormalParameter.Mode newMode,
                       java.lang.Object newType)

Creates a new FormalParameter.

Parameters:

newId - identifier of the formal parameter in String

newIndex - index of the formal parameter in String. In the 1.iteration if the new Index is not null, a warning will be generated.

newMode - mode of this formal parameter

newType - type of this formal parameter

Method Detail

id

public java.lang.String id()

Return the id of the formal parameter.

Returns:

a String representing the id value

index

public java.lang.String index()

Return the index of the formal parameter.

Returns:

a String representing the index value

mode

public FormalParameter.Mode mode()

Return the mode of the formal parameter.

Returns:

the FormalParameter.Mode of the formal parameter.

type

public java.lang.Object type()

Return the type of the formal parameter. Types are represented as defined for ProcessMgr.contextSignature.

Returns:

the type of the formal parameter.

equals

public boolean equals(java.lang.Object obj)

Compare two formal parameter objects.

Parameters:

obj - the object to compare with.

Returns:

true if the objects are equal.

hashCode

public int hashCode()

Evaluate hash code.

Returns:

the hash code.

toString

public java.lang.String toString()

Create string representation for debugging purposes.

Returns:

the result.