All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class bea.jolt.JoltParam 

java.lang.Object
   |
   +----bea.jolt.JoltDefAttrs
           |
           +----bea.jolt.JoltParam
public class JoltParam
extends JoltDefAttrs
JoltParam implements the parameter object in a service definition object. It contains the name, data type, access information, and more about the parameter.

See Also:
JoltDefinition, JoltDefAttrs

Variable Index

o NOACCESS
The numeric value for access type: NOACCESS
o READONLY
The numeric value for access type: READONLY
o READWRITE
The numeric value for access type: READWRITE
o WRITEONLY
The numeric value for access type: WRITEONLY

Constructor Index

o JoltParam()

Method Index

o accessType()
Get the access type that is relative to the service.
o addProperty(String, String)
Add a parameter property as the name-value pair.
o getID()
Get the field ID of the parameter.
o getKeys()
Get an enumeration of the property keys.
o getMaxLength()
Get the max length defined.
o getMaxOccurrence()
Get the max occurrence defined.
o getName()
Get the name of the parameter.
o getProperty(String)
Get a property element of the parameter.
o getType()
Get the data type.
o isMandatory()
Check if the parameter is a manadatory field.
o toString()
Construct the string for the parameter begin with "bp:" and end with "ep:".

Variables

o NOACCESS 
 public static final int NOACCESS
The numeric value for access type: NOACCESS

o READONLY 
 public static final int READONLY
The numeric value for access type: READONLY

o WRITEONLY 
 public static final int WRITEONLY
The numeric value for access type: WRITEONLY

o READWRITE 
 public static final int READWRITE
The numeric value for access type: READWRITE

Constructors

o JoltParam 
 public JoltParam()

Methods

o getName 
 public String getName()
Get the name of the parameter.

Returns:
the parameter name
o getID 
 public int getID()
Get the field ID of the parameter. A field ID is composed of a data type information and a unique sequence number within a definition.

Returns:
the internal field id
See Also:
SBuffer
o accessType 
 public int accessType()
Get the access type that is relative to the service. The NOACCESS can be used if the parameter has an indirect parameter The READONLY means an input field of the service. The WRITEONLY means an output field of the service. The READWRITE means an input/output field of the service.

Returns:
NOACCESS, READONLY, WRITEONLY or READWRITE
o getType 
 public int getType()
Get the data type. Note: we don't use the value from "pt," which is in human readable format. Howevr, it may not accurate because the the string may change. The real data type is from the "pf".

Returns:
the actual data type
See Also:
SBuffer
o isMandatory 
 public boolean isMandatory()
Check if the parameter is a manadatory field. Currently this field is not enforced.

Returns:
true if it is manadatory; false otherwise.
o getMaxOccurrence 
 public int getMaxOccurrence()
Get the max occurrence defined. If this property is not defined, it is defaulted to 1. Currently this field is not enforced.

Returns:
the max occurenence, or 0 if it is infinite or undefined.
o getMaxLength 
 public int getMaxLength()
Get the max length defined. This field is intended for string or carray (opaque binary) data type. Currently this field is not enforced.

Returns:
the max length or 0 if it is undefined.
o getProperty 
 public String getProperty(String name)
Get a property element of the parameter.

Parameters:
name - the name of the parameter
Returns:
the String value of the property element, or null if not found.
o getKeys 
 public Enumeration getKeys()
Get an enumeration of the property keys.

Returns:
Enumeration of the keys
See Also:
Enumeration
o toString 
 public String toString()
Construct the string for the parameter begin with "bp:" and end with "ep:".

Returns:
String of the parameter
Overrides:
toString in class Object
o addProperty 
 public void addProperty(String name,
                         String val) throws NumberFormatException, DefinitionException
Add a parameter property as the name-value pair.

Parameters:
name - Name of the parameter
val - Value of the parameter
Throws: NumberFormatException
If "pf" or "fi" does not contain a parseable integer.
Throws: DefinitionException
If "pa" has an invalid value. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index