| java.lang.Object
 org.enhydra.shark.api.internal.toolagent.AppParameter
| AppParameter | | final public class AppParameter implements Serializable(Code) | | 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:
- it defines two fields for parameter name (instead of one as it is in spec):
the actual one, and the formal one
- it defines additional field which determines the mode of parameter
(it can be input, output or input and output parameter).
- it defined additional field which determines the Java class
for the parameter
|
| Field Summary | |
| public String | the_actual_name
The name of the actual parameter (shark variable). | | public Class | the_class
The java class of parameter. | | public String | the_formal_name
The name of the formal parameter of XPDL application definition
that corresponds to this AppParameter instance. | | public long | the_length
The length of parameter value. | | public String | the_mode
The mode of the formal parameter, as defined in its XPDL application
definition. | | public long | the_type
The type of parameter. | | public 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 | |
| public | AppParameter()
Creates instance with all object fields initialized to null possible
and primitive type fields to -1. | | public | AppParameter(String _the_actual_name, String _the_formal_name, String _the_mode, Object _the_value, Class _the_class)
Creates an instance with fields set to the given parameter values
(the_length and the_type fields are initialize to -1). | | public | AppParameter(String _the_actual_name, String _the_formal_name, String _the_mode, Object _the_value, Class _the_class, long _the_length_, long _the_type_)
Creates an instance with fields set to the given parameter values. |
| the_actual_name | | public String the_actual_name(Code) | | 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_class | | public Class the_class(Code) | | The java class of parameter.
|
| the_formal_name | | public String the_formal_name(Code) | | The name of the formal parameter of XPDL application definition
that corresponds to this AppParameter instance.
|
| the_length | | public long the_length(Code) | | 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_mode | | public String the_mode(Code) | | The mode of the formal parameter, as defined in its XPDL application
definition. It can be:
- "IN" - then shark doesn't take into account the value of this
parameter after execution of tool agent.
- "OUT" - then shark takes into account the value of this parameter
after execution, but tool agent application should not care about
this parameter value when it gets it.
- "INOUT" - then both, shark and tool agent application take into
account the value of this parameter.
|
| the_type | | public long the_type(Code) | | 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.
|
| the_value | | public Object the_value(Code) | | 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.
|
| AppParameter | | public AppParameter()(Code) | | Creates instance with all object fields initialized to null possible
and primitive type fields to -1.
|
| AppParameter | | public AppParameter(String _the_actual_name, String _the_formal_name, String _the_mode, Object _the_value, Class _the_class)(Code) | | Creates an instance with fields set to the given parameter values
(the_length and the_type fields are initialize to -1).
|
| AppParameter | | public AppParameter(String _the_actual_name, String _the_formal_name, String _the_mode, Object _the_value, Class _the_class, long _the_length_, long _the_type_)(Code) | | Creates an instance with fields set to the given parameter values.
|
|
|