org.enhydra.shark.api.internal.toolagent
Class AppParameter

java.lang.Object
  extended byorg.enhydra.shark.api.internal.toolagent.AppParameter
All Implemented Interfaces:
java.io.Serializable

public final class AppParameter
extends java.lang.Object
implements java.io.Serializable

This class represents the parameter passed to tool agent application. It holds all neccessary information about shark's activity variable. It differs from original WfMC spec in the following:

See Also:
Serialized Form

Field Summary
 java.lang.String the_actual_name
          The name of the actual parameter (shark variable).
 java.lang.Class the_class
          The java class of parameter.
 java.lang.String the_formal_name
          The name of the formal parameter of XPDL application definition that corresponds to this AppParameter instance.
 long the_length
          The length of parameter value.
 java.lang.String the_mode
          The mode of the formal parameter, as defined in its XPDL application definition.
 long the_type
          The type of parameter.
 java.lang.Object the_value
          The value of the parameter - this is a value of a shark variable if mode of corresponding FormalParameter from XPDL Application Definition is OUT or IN_OUT, otherwise it is the value of evaluated expression for the actual parameter in XPDL.
 
Constructor Summary
AppParameter()
          Creates instance with all object fields initialized to null possible and primitive type fields to -1.
AppParameter(java.lang.String _the_actual_name, java.lang.String _the_formal_name, java.lang.String _the_mode, java.lang.Object _the_value, java.lang.Class _the_class)
          Creates an instance with fields set to the given parameter values (the_length and the_type fields are initialize to -1).
AppParameter(java.lang.String _the_actual_name, java.lang.String _the_formal_name, java.lang.String _the_mode, java.lang.Object _the_value, java.lang.Class _the_class, long _the_length_, long _the_type_)
          Creates an instance with fields set to the given parameter values.
 
Method Summary
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

the_actual_name

public java.lang.String the_actual_name
The name of the actual parameter (shark variable). This is the Id of the FormalParameter or DataField from XPDL definition, if mode of corresponding FormalParameter from XPDL Application Definition is OUT or IN_OUT, otherwise it is the expression which is evaluated to get the value contained in this object.


the_formal_name

public java.lang.String the_formal_name
The name of the formal parameter of XPDL application definition that corresponds to this AppParameter instance.


the_mode

public java.lang.String the_mode
The mode of the formal parameter, as defined in its XPDL application definition. It can be:


the_value

public java.lang.Object the_value
The value of the parameter - this is a value of a shark variable if mode of corresponding FormalParameter from XPDL Application Definition is OUT or IN_OUT, otherwise it is the value of evaluated expression for the actual parameter in XPDL.


the_class

public java.lang.Class the_class
The java class of parameter.


the_length

public long the_length
The length of parameter value. This is not used in standard shark kernel implementation, and it is defined only to stay as close as possible to WfMC spec.


the_type

public long the_type
The type of parameter. This is not used in standard shark kernel implementation, and it is defined only to stay as close as possible to WfMC spec.

Constructor Detail

AppParameter

public AppParameter()
Creates instance with all object fields initialized to null possible and primitive type fields to -1.


AppParameter

public AppParameter(java.lang.String _the_actual_name,
                    java.lang.String _the_formal_name,
                    java.lang.String _the_mode,
                    java.lang.Object _the_value,
                    java.lang.Class _the_class)
Creates an instance with fields set to the given parameter values (the_length and the_type fields are initialize to -1).


AppParameter

public AppParameter(java.lang.String _the_actual_name,
                    java.lang.String _the_formal_name,
                    java.lang.String _the_mode,
                    java.lang.Object _the_value,
                    java.lang.Class _the_class,
                    long _the_length_,
                    long _the_type_)
Creates an instance with fields set to the given parameter values.

Method Detail

toString

public java.lang.String toString()