bea.jolt

Class JoltParam

java.lang.Object

bea.jolt.JoltDefAttrs

bea.jolt.JoltParam

Direct Known Subclasses:

JoltParam4RE

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOACCESS The numeric value for access type: NOACCESS
static int	READONLY The numeric value for access type: READONLY
static int	READWRITE The numeric value for access type: READWRITE
static int	WRITEONLY The numeric value for access type: WRITEONLY

Fields inherited from class bea.jolt.JoltDefAttrs

AVLIST, BINARY, BOE, BOOLEAN, BOP, BYTE, CONVERSATION, DOUBLE, EOE, EOP, EVENT, FLOAT, IBUFTYPE, INTEGER, IVIEWNAME, LONG, MANDATORY, NOACC, OBUFTYPE, OPTIONAL, OVIEWNAME, PARMACC, PARMDESC, PARMFID, PARMFINDEX, PARMFNAME, PARMLEN, PARMNAME, PARMOCC, PARMSTATUS, PARMSUBTYPE, PARMTYPE, QSPACE, QUEUE, RDONLY, RDWR, SERVICE, SHORT, STRING, VERSION, VIEW32, WRONLY

Constructor Summary

Constructors

Constructor and Description
JoltParam()

Method Summary

Methods

Modifier and Type	Method and Description
int	accessType() Get the access type that is relative to the service.
void	addProperty(java.lang.String name, java.lang.String val) Add a parameter property as the name-value pair.
JoltDefinition	getDefinition() Get the nested definition
int	getID() Get the field ID of the parameter.
java.util.Enumeration	getKeys() Get an enumeration of the property keys.
int	getMaxLength() Get the max length defined.
int	getMaxOccurrence() Get the max occurrence defined.
java.lang.String	getName() Get the name of the parameter.
java.lang.String	getProperty(java.lang.String name) Get a property element of the named parameter.
int	getType() Get the data type.
java.lang.String	getViewName() Get the view name of the parameter if it is a nested view
boolean	isMandatory() Check if the parameter is a manadatory field.
java.lang.String	toString() Construct the string for the parameter beginning with "bp:" and ending with "ep:".

Methods inherited from class bea.jolt.JoltDefAttrs

getInteger

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NOACCESS

public static final int NOACCESS

The numeric value for access type: NOACCESS

See Also:

Constant Field Values

READONLY

public static final int READONLY

The numeric value for access type: READONLY

See Also:

Constant Field Values

WRITEONLY

public static final int WRITEONLY

The numeric value for access type: WRITEONLY

See Also:

Constant Field Values

READWRITE

public static final int READWRITE

The numeric value for access type: READWRITE

See Also:

Constant Field Values

Constructor Detail

JoltParam

public JoltParam()

Method Detail

getName

public java.lang.String getName()

Get the name of the parameter.

Returns:

the parameter name

getViewName

public java.lang.String getViewName()

Get the view name of the parameter if it is a nested view

Returns:

the view name

getDefinition

public JoltDefinition getDefinition()

Get the nested definition

Returns:

the embeded jolt definition

getID

public int getID()

Get the field ID of the parameter. A field ID is composed of data type information and a unique sequence number within a definition.

Returns:

the internal field id

See Also:

SBuffer

accessType

public int accessType()

Get the access type that is relative to the service. NOACCESS can be used if the parameter has an indirect parameter. READONLY means an input field of the service. The WRITEONLY means an output field of the service. READWRITE means an input/output field of the service.

Returns:

NOACCESS, READONLY, WRITEONLY or READWRITE

getType

public int getType()

Get the data type. Note: The value from "pt," which is in human readable format, is not used. However, it may not be accurate because the string may change. The actual data type is from the "pf".

Returns:

the actual data type

See Also:

SBuffer

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.

getMaxOccurrence

public int getMaxOccurrence()

Get the max occurrence defined. If this property is not defined, the default is 1. Currently this field is not enforced.

Returns:

The max occurrence, or 0 if it is infinite or undefined.

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.

getProperty

public java.lang.String getProperty(java.lang.String name)

Get a property element of the named parameter.

Parameters:

name - the name of the parameter

Returns:

The String value of the property element, or null if not found.

getKeys

public java.util.Enumeration getKeys()

Get an enumeration of the property keys.

Returns:

Enumeration of the keys

See Also:

Enumeration

toString

public java.lang.String toString()

Construct the string for the parameter beginning with "bp:" and ending with "ep:".

Overrides:

toString in class java.lang.Object

Returns:

String of the parameter

addProperty

public void addProperty(java.lang.String name,
               java.lang.String val)
                 throws java.lang.NumberFormatException,
                        DefinitionException

Add a parameter property as the name-value pair.

Parameters:

name - Name of the parameter

val - Value of the parameter

Throws:

java.lang.NumberFormatException - If "pf" or "fi" does not contain a parseable integer.

DefinitionException - If "pa" has an invalid value.