bea.jolt

Class JoltRemoteService

java.lang.Object

bea.jolt.JoltRequest

bea.jolt.JoltRemoteService

All Implemented Interfaces:

Message

public class JoltRemoteService
extends JoltRequest
implements Message

JoltRemoteService provides an implementation of the Tuxedo synchronous Request/Reply communication model. Jolt treats each Tuxedo service as a remote service, and each service has its input and output parameters. Typically, the user sets the input parameters through the various setXXX and addXXX methods, then invokes the call() method. Upon successful completion, the user retreives the results through the various getXXX methods. Since Queue is not supported in release 1.0, this class is extended from JoltRequest and implements RemoteService/Message to reduce the class file size. When Queue is supported in a later release, this class and RemoteQueue will be extended from JoltRequestMessage to share the single implementation of Message.

See Also:

JoltSession, JoltTransaction

Field Summary

Fields

Modifier and Type	Field and Description
static int	QUEUE
static int	SERVICE

Constructor Summary

Constructors

Constructor and Description
JoltRemoteService(java.lang.String name, Session s) This constructor gets the service that matches the definition in the repository.
JoltRemoteService(java.lang.String name, Session s, int version) This constructor ensures that the version between a client program and the data in the repository match.

Method Summary

Modifier and Type	Method and Description
void	addBoolean(java.lang.String name, boolean val) Add a boolean value occurrence of an item referred by its name.
void	addByte(java.lang.String name, byte val) Add a byte value occurrence of an item referred by its name.
void	addBytes(java.lang.String name, byte[] val, int len) Add a byte-array value occurrence of an item referred by its name.
void	addDouble(java.lang.String name, double val) Add a double value occurrence of an item referred by its name.
void	addFloat(java.lang.String name, float val) Add a float value occurrence of an item referred by its name.
void	addInt(java.lang.String name, int val) Add a int value occurrence of an item referred by its name.
void	addLong(java.lang.String name, long val) Add a long value occurrence of an item referred by its name.
void	addMBString(java.lang.String name, java.lang.String val) Add a mbstring value occurrence of an item referred by its name.
void	addMessage(java.lang.String name, JoltView32 val) Add a JoltView32 object occurrence of an item referred by its name.
void	addShort(java.lang.String name, short val) Add a short value occurrence of an item referred by its name.
void	addString(java.lang.String name, java.lang.String val) Add a string value occurrence of an item referred by its name.
void	call(bea.jolt.Transaction trans) Perform the synchronized request/reply.
void	call(bea.jolt.Transaction trans, java.lang.String principal, java.lang.String realm)
void	clear() Clear the input and output attributes, and the priority.
void	delete(java.lang.String name) Delete the first instance of an item referred by its name.
void	deleteItem(java.lang.String name, int itemNo) Delete a particular occurrence of an item referred by its name.
void	done() Done with this service object and perform some clean up.
int	getApplicationCode() Get the return code from the application; it is equivalent to the tpurcode or the second parameter of tpreturn(3) from ATMI.
boolean	getBooleanDef(java.lang.String name, boolean def) Get the boolean value of the first occurrence of the item.
boolean	getBooleanItemDef(java.lang.String name, int itemNo, boolean def) Get an occurrence of a named item of boolean data type.
byte	getByteDef(java.lang.String name, byte def) Get the byte value of the first occurrence of the item.
byte	getByteItemDef(java.lang.String name, int itemNo, byte def) Get the byte value of an occurrence of the item.
byte[]	getBytesDef(java.lang.String name, byte[] def) Get the byte-array value of the first occurrence of the item.
byte[]	getBytesItemDef(java.lang.String name, int itemNo, byte[] def) Get the byte-array value of an occurrence of the item.
JoltDefinition	getDefinition() Get the reference to the service definition.
double	getDoubleDef(java.lang.String name, double def) Get the double value of the first occurrence of the item.
double	getDoubleItemDef(java.lang.String name, int itemNo, double def) Get the double value of an occurrence of the item.
float	getFloatDef(java.lang.String name, float def) Get the float value of the first occurrence of the item.
float	getFloatItemDef(java.lang.String name, int itemNo, float def) Get the float value of an occurrence of the item.
JoltMessage	getInputs() Get the input parameter message buffer.
int	getIntDef(java.lang.String name, int def) Get the int value of the first occurrence of the item.
int	getIntItemDef(java.lang.String name, int itemNo, int def) Get the int value of an occurrence of the item.
long	getLongDef(java.lang.String name, long def) Get the long value of the first occurrence of the item.
long	getLongItemDef(java.lang.String name, int itemNo, long def) Get an occurrence of a named item of long data type.
java.lang.String	getMBStringDef(java.lang.String name, java.lang.String def) Get the mbstring value of the first occurrence of the item.
java.lang.String	getMBStringItemDef(java.lang.String name, int itemNo, java.lang.String def) Get the mbstring value of an occurrence of the item.
JoltView32	getMessageDef(java.lang.String name, JoltView32 def) Get the JoltView32 object of the first occurrence of the item.
JoltView32	getMessageItemDef(java.lang.String name, int itemNo, JoltView32 def) Get the JoltView32 object of an occurrence of the item.
java.lang.String	getName() Get the name of this service.
int	getOccurrenceCount(java.lang.String name) Get the occurrence count of an item referred by its name.
JoltMessage	getOutputs() Get the output parameter message buffer.
int	getRequestType() Get the type of this request object.
short	getShortDef(java.lang.String name, short def) Get the short value of the first occurrence of the item.
short	getShortItemDef(java.lang.String name, int itemNo, short def) Get the short value of an occurrence of the item.
java.lang.String	getStringDef(java.lang.String name, java.lang.String def) Get the string value of the first occurrence of the item.
java.lang.String	getStringItemDef(java.lang.String name, int itemNo, java.lang.String def) Get the string value of an occurrence of the item.
void	setBoolean(java.lang.String name, boolean val) Set or change the boolean value of the first occurrence of an item referred by its name.
void	setBooleanItem(java.lang.String name, int itemNo, boolean val) Set or change the boolean value of a particular item referred by its name.
void	setByte(java.lang.String name, byte val) Set or change the byte value of the first occurrence of an item referred by its name.
void	setByteItem(java.lang.String name, int itemNo, byte val) Set or change the byte value of a particular item referred by its name.
void	setBytes(java.lang.String name, byte[] val, int len) Set or change the byte-array value of the first occurrence of an item referred by its name.
void	setBytesItem(java.lang.String name, int itemNo, byte[] val, int len) Set or change the byte-array value of a particular item referred by its name.
void	setDouble(java.lang.String name, double val) Set or change the double value of the first occurrence of an item referred by its name.
void	setDoubleItem(java.lang.String name, int itemNo, double val) Set or change the double value of a particular item referred by its name.
void	setFloat(java.lang.String name, float val) Set or change the float value of the first occurrence of an item referred by its name.
void	setFloatItem(java.lang.String name, int itemNo, float val) Set or change the float value of a particular item referred by its name.
void	setInt(java.lang.String name, int val) Set or change the int value of the first occurrence of an item referred by its name.
void	setIntItem(java.lang.String name, int itemNo, int val) Set or change the int value of a particular item referred by its name.
void	setLong(java.lang.String name, long val) Set or change the long value of the first occurrence of an item referred by its name.
void	setLongItem(java.lang.String name, int itemNo, long val) Set or change the long value of a particular item referred by its name.
void	setMBString(java.lang.String name, java.lang.String val) Set or change the mbstring value of the first occurrence of an item referred by its name.
void	setMBStringItem(java.lang.String name, int itemNo, java.lang.String val) Set or change the mbstring value of a particular item referred by its name.
void	setMessage(java.lang.String name, JoltView32 val) Set or change the JoltView32 object of the first occurrence of an item referred by its name.
void	setMessageItem(java.lang.String name, int itemNo, JoltView32 val) Set or change the JoltView32 object of a particular item referred by its name.
void	setShort(java.lang.String name, short val) Set or change the short value of the first occurrence of an item referred by its name.
void	setShortItem(java.lang.String name, int itemNo, short val) Set or change the short value of a particular item referred by its name.
void	setString(java.lang.String name, java.lang.String val) Set or change the string value of the first occurrence of an item referred by its name.
void	setStringItem(java.lang.String name, int itemNo, java.lang.String val) Set or change the string value of a particular item referred by its name.
java.lang.String	toString() Get the service name of this object.

Methods inherited from class bea.jolt.JoltRequest

setNoTimeOut, setRequestPriority

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

public static final int SERVICE

See Also:

Constant Field Values

QUEUE

public static final int QUEUE

See Also:

Constant Field Values

Constructor Detail

JoltRemoteService

public JoltRemoteService(java.lang.String name,
                         Session s)
                  throws ServiceException

This constructor gets the service that matches the definition in the repository. It does NOT enforce the client program to be in sync with the repository. Typically, generic application (which is not bounded with any definition) will use this constructor.

Parameters:

name - The service name

s - The session object

Throws:

ServiceException - Invalid session or no such service.

JoltRemoteService

public JoltRemoteService(java.lang.String name,
                         Session s,
                         int version)
                  throws ServiceException,
                         bea.jolt.JoltVersionException

This constructor ensures that the version between a client program and the data in the repository match. If the user is concerned with the version, use of this constructor is recommended.

Parameters:

name - The service name

s - The session object

version - The version number

Throws:

ServiceException - Invalid session, the service does not exist, or is not exported.

JoltVersionException - No such version.

Method Detail

done

public void done()

Done with this service object and perform some clean up. This object is no longer valid.

getRequestType

public int getRequestType()

Get the type of this request object.

Returns:

Always returns SERVICE.

getName

public java.lang.String getName()

Get the name of this service.

Returns:

The name of this service.

getApplicationCode

public int getApplicationCode()

Get the return code from the application; it is equivalent to the tpurcode or the second parameter of tpreturn(3) from ATMI.

Returns:

The application return code.

getDefinition

public JoltDefinition getDefinition()

Get the reference to the service definition. Note, caller should not modify the return object.

Returns:

The service definition.

See Also:

JoltDefinition

call

public void call(bea.jolt.Transaction trans)
          throws ServiceException,
                 TransactionException,
                 ApplicationException

Perform the synchronized request/reply. User should use set/add methods to set the input attributes prior to this method. If the user wants to include this request/reply in a transaction, a transaction object must be passed in. When excluding this request/reply from a transaction or invoking this service without any transaction, the "trans" parameter should be set to null. Upon successful completion, user can use getXXX methods to retrieve the results. When the transactional service is invoked, the receiving timeout is automatically set to the greater value of the transaction timeout or the default receiving timeout.

Parameters:

trans - The transaction object or null

Throws:

ServiceException - Tuxedo system level error has occurred.

TransactionException - Invalid transaction object, the transaction has been suspended or aborted, or time-out has occurred.

ApplicationException - Application level error has occurred.

See Also:

clear(), JoltTransaction

call

public void call(bea.jolt.Transaction trans,
                 java.lang.String principal,
                 java.lang.String realm)
          throws ServiceException,
                 TransactionException,
                 ApplicationException

Throws:

ServiceException

TransactionException

ApplicationException

toString

public java.lang.String toString()

Get the service name of this object.

Overrides:

toString in class java.lang.Object

Returns:

The service name.

clear

public void clear()

Clear the input and output attributes, and the priority.

Specified by:

clear in interface Message

addBoolean

public void addBoolean(java.lang.String name,
                       boolean val)

Add a boolean value occurrence of an item referred by its name.

Parameters:

name - The name of the item.

val - The boolean value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

addByte

public void addByte(java.lang.String name,
                    byte val)

Add a byte value occurrence of an item referred by its name.

Specified by:

addByte in interface Message

Parameters:

name - The name of the item.

val - The byte value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

addShort

public void addShort(java.lang.String name,
                     short val)

Add a short value occurrence of an item referred by its name.

Specified by:

addShort in interface Message

Parameters:

name - The name of the item.

val - The short value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

addInt

public void addInt(java.lang.String name,
                   int val)

Add a int value occurrence of an item referred by its name.

Specified by:

addInt in interface Message

Parameters:

name - The name of the item.

val - The int value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

addLong

public void addLong(java.lang.String name,
                    long val)

Add a long value occurrence of an item referred by its name.

Parameters:

name - The name of the item.

val - The long value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

addFloat

public void addFloat(java.lang.String name,
                     float val)

Add a float value occurrence of an item referred by its name.

Specified by:

addFloat in interface Message

Parameters:

name - The name of the item.

val - The float value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

addDouble

public void addDouble(java.lang.String name,
                      double val)

Add a double value occurrence of an item referred by its name.

Specified by:

addDouble in interface Message

Parameters:

name - The name of the item.

val - The double value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

addString

public void addString(java.lang.String name,
                      java.lang.String val)

Add a string value occurrence of an item referred by its name.

Specified by:

addString in interface Message

Parameters:

name - The name of the item.

val - The string value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

addBytes

public void addBytes(java.lang.String name,
                     byte[] val,
                     int len)

Add a byte-array value occurrence of an item referred by its name.

Specified by:

addBytes in interface Message

Parameters:

name - The name of the item.

val - The byte-array value.

len - The number of bytes to be added.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

addMBString

public void addMBString(java.lang.String name,
                        java.lang.String val)

Add a mbstring value occurrence of an item referred by its name.

Specified by:

addMBString in interface Message

Parameters:

name - The name of the item.

val - The mbstring value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

addMessage

public void addMessage(java.lang.String name,
                       JoltView32 val)

Add a JoltView32 object occurrence of an item referred by its name.

Parameters:

name - The name of the item.

val - The view32 value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setBoolean

public void setBoolean(java.lang.String name,
                       boolean val)

Set or change the boolean value of the first occurrence of an item referred by its name.

Parameters:

name - The name of the item.

val - The boolean value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setByte

public void setByte(java.lang.String name,
                    byte val)

Set or change the byte value of the first occurrence of an item referred by its name.

Specified by:

setByte in interface Message

Parameters:

name - The name of the item.

val - The byte value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setShort

public void setShort(java.lang.String name,
                     short val)

Set or change the short value of the first occurrence of an item referred by its name.

Specified by:

setShort in interface Message

Parameters:

name - The name of the item.

val - The short value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setInt

public void setInt(java.lang.String name,
                   int val)

Set or change the int value of the first occurrence of an item referred by its name.

Specified by:

setInt in interface Message

Parameters:

name - The name of the item.

val - The int value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setLong

public void setLong(java.lang.String name,
                    long val)

Set or change the long value of the first occurrence of an item referred by its name.

Parameters:

name - The name of the item.

val - The long value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setFloat

public void setFloat(java.lang.String name,
                     float val)

Set or change the float value of the first occurrence of an item referred by its name.

Specified by:

setFloat in interface Message

Parameters:

name - The name of the item.

val - The float value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setDouble

public void setDouble(java.lang.String name,
                      double val)

Set or change the double value of the first occurrence of an item referred by its name.

Specified by:

setDouble in interface Message

Parameters:

name - The name of the item.

val - The double value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setString

public void setString(java.lang.String name,
                      java.lang.String val)

Set or change the string value of the first occurrence of an item referred by its name.

Specified by:

setString in interface Message

Parameters:

name - The name of the item.

val - The string value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setBytes

public void setBytes(java.lang.String name,
                     byte[] val,
                     int len)

Set or change the byte-array value of the first occurrence of an item referred by its name.

Specified by:

setBytes in interface Message

Parameters:

name - The name of the item.

val - The byte-array value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setMBString

public void setMBString(java.lang.String name,
                        java.lang.String val)

Set or change the mbstring value of the first occurrence of an item referred by its name.

Specified by:

setMBString in interface Message

Parameters:

name - The name of the item.

val - The mbstring value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setMessage

public void setMessage(java.lang.String name,
                       JoltView32 val)

Set or change the JoltView32 object of the first occurrence of an item referred by its name.

Parameters:

name - The name of the item.

val - The JoltView32 object.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setBooleanItem

public void setBooleanItem(java.lang.String name,
                           int itemNo,
                           boolean val)

Set or change the boolean value of a particular item referred by its name. The instance starts from 0.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The boolean value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setByteItem

public void setByteItem(java.lang.String name,
                        int itemNo,
                        byte val)

Set or change the byte value of a particular item referred by its name. The instance starts from 0.

Specified by:

setByteItem in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The byte value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setShortItem

public void setShortItem(java.lang.String name,
                         int itemNo,
                         short val)

Set or change the short value of a particular item referred by its name. The instance starts from 0.

Specified by:

setShortItem in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The short value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setIntItem

public void setIntItem(java.lang.String name,
                       int itemNo,
                       int val)

Set or change the int value of a particular item referred by its name. The instance starts from 0.

Specified by:

setIntItem in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The int value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setLongItem

public void setLongItem(java.lang.String name,
                        int itemNo,
                        long val)

Set or change the long value of a particular item referred by its name. The instance starts from 0.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The long value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setFloatItem

public void setFloatItem(java.lang.String name,
                         int itemNo,
                         float val)

Set or change the float value of a particular item referred by its name. The instance starts from 0.

Specified by:

setFloatItem in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The float value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setDoubleItem

public void setDoubleItem(java.lang.String name,
                          int itemNo,
                          double val)

Set or change the double value of a particular item referred by its name. The instance starts from 0.

Specified by:

setDoubleItem in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The double value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setStringItem

public void setStringItem(java.lang.String name,
                          int itemNo,
                          java.lang.String val)

Set or change the string value of a particular item referred by its name. The instance starts from 0.

Specified by:

setStringItem in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The string value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setBytesItem

public void setBytesItem(java.lang.String name,
                         int itemNo,
                         byte[] val,
                         int len)

Set or change the byte-array value of a particular item referred by its name. The instance starts from 0.

Specified by:

setBytesItem in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The byte-array value.

len - The length of the byte-array.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setMBStringItem

public void setMBStringItem(java.lang.String name,
                            int itemNo,
                            java.lang.String val)

Set or change the mbstring value of a particular item referred by its name. The instance starts from 0.

Specified by:

setMBStringItem in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The mbstring value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

setMessageItem

public void setMessageItem(java.lang.String name,
                           int itemNo,
                           JoltView32 val)

Set or change the JoltView32 object of a particular item referred by its name. The instance starts from 0.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

val - The JoltView32 object.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an output field.

delete

public void delete(java.lang.String name)

Delete the first instance of an item referred by its name.

Specified by:

delete in interface Message

Parameters:

name - The name of the item.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

deleteItem

public void deleteItem(java.lang.String name,
                       int itemNo)

Delete a particular occurrence of an item referred by its name.

Specified by:

deleteItem in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getOccurrenceCount

public int getOccurrenceCount(java.lang.String name)

Get the occurrence count of an item referred by its name.

Specified by:

getOccurrenceCount in interface Message

Parameters:

name - The name of the item.

Returns:

The number of occurrence.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getBooleanDef

public boolean getBooleanDef(java.lang.String name,
                             boolean def)

Get the boolean value of the first occurrence of the item. If the item does not exist, the default value will be returned.

Parameters:

name - The name fo the item.

def - The default boolean value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getByteDef

public byte getByteDef(java.lang.String name,
                       byte def)

Get the byte value of the first occurrence of the item. If the item does not exist, the default value will be returned.

Specified by:

getByteDef in interface Message

Parameters:

name - The name fo the item.

def - The default byte value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getShortDef

public short getShortDef(java.lang.String name,
                         short def)

Get the short value of the first occurrence of the item. If the item does not exist, the default value will be returned.

Specified by:

getShortDef in interface Message

Parameters:

name - The name fo the item.

def - The default short value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getIntDef

public int getIntDef(java.lang.String name,
                     int def)

Get the int value of the first occurrence of the item. If the item does not exist, the default value will be returned.

Specified by:

getIntDef in interface Message

Parameters:

name - The name fo the item.

def - The default int value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getLongDef

public long getLongDef(java.lang.String name,
                       long def)

Get the long value of the first occurrence of the item. If the item does not exist, the default value will be returned.

Parameters:

name - The name fo the item.

def - The default long value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getFloatDef

public float getFloatDef(java.lang.String name,
                         float def)

Get the float value of the first occurrence of the item. If the item does not exist, the default value will be returned.

Specified by:

getFloatDef in interface Message

Parameters:

name - The name fo the item.

def - The default float value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getDoubleDef

public double getDoubleDef(java.lang.String name,
                           double def)

Get the double value of the first occurrence of the item. If the item does not exist, the default value will be returned.

Specified by:

getDoubleDef in interface Message

Parameters:

name - The name fo the item.

def - The default double value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getStringDef

public java.lang.String getStringDef(java.lang.String name,
                                     java.lang.String def)

Get the string value of the first occurrence of the item. If the item does not exist, the default value will be returned.

Specified by:

getStringDef in interface Message

Parameters:

name - The name fo the item.

def - The default string value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getMBStringDef

public java.lang.String getMBStringDef(java.lang.String name,
                                       java.lang.String def)

Get the mbstring value of the first occurrence of the item. If the item does not exist, the default value will be returned.

Specified by:

getMBStringDef in interface Message

Parameters:

name - The name fo the item.

def - The default mbstring value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getMessageDef

public JoltView32 getMessageDef(java.lang.String name,
                                JoltView32 def)

Get the JoltView32 object of the first occurrence of the item. If the item does not exist, the default object will be returned.

Parameters:

name - The name fo the item.

def - The default JoltView32 object

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getBytesDef

public byte[] getBytesDef(java.lang.String name,
                          byte[] def)

Get the byte-array value of the first occurrence of the item. If the item does not exist, the default value will be returned.

Specified by:

getBytesDef in interface Message

Parameters:

name - The name fo the item.

def - The default byte-array value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getByteItemDef

public byte getByteItemDef(java.lang.String name,
                           int itemNo,
                           byte def)

Get the byte value of an occurrence of the item. If the item or its occurrence does not exist, the default value will be returned. The occurence number starts at 0.

Specified by:

getByteItemDef in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

def - The default byte value.

Returns:

A byte value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getShortItemDef

public short getShortItemDef(java.lang.String name,
                             int itemNo,
                             short def)

Get the short value of an occurrence of the item. If the item or its occurrence does not exist, the default value will be returned. The occurence number starts at 0.

Specified by:

getShortItemDef in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

def - The default short value.

Returns:

A short value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getIntItemDef

public int getIntItemDef(java.lang.String name,
                         int itemNo,
                         int def)

Get the int value of an occurrence of the item. If the item or its occurrence does not exist, the default value will be returned. The occurence number starts at 0.

Specified by:

getIntItemDef in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

def - The default int value.

Returns:

An int value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getFloatItemDef

public float getFloatItemDef(java.lang.String name,
                             int itemNo,
                             float def)

Get the float value of an occurrence of the item. If the item or its occurrence does not exist, the default value will be returned. The occurence number starts at 0.

Specified by:

getFloatItemDef in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

def - The default float value.

Returns:

A float value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getDoubleItemDef

public double getDoubleItemDef(java.lang.String name,
                               int itemNo,
                               double def)

Get the double value of an occurrence of the item. If the item or its occurrence does not exist, the default value will be returned. The occurence number starts at 0.

Specified by:

getDoubleItemDef in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

def - The default double value.

Returns:

A double value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getStringItemDef

public java.lang.String getStringItemDef(java.lang.String name,
                                         int itemNo,
                                         java.lang.String def)

Get the string value of an occurrence of the item. If the item or its occurrence does not exist, the default value will be returned. The occurence number starts at 0.

Specified by:

getStringItemDef in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

def - The default string value.

Returns:

A string value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getBytesItemDef

public byte[] getBytesItemDef(java.lang.String name,
                              int itemNo,
                              byte[] def)

Get the byte-array value of an occurrence of the item. If the item or its occurrence does not exist, the default value will be returned. The occurence number starts at 0.

Specified by:

getBytesItemDef in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

def - The default byte-array value.

Returns:

A byte-array object.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getMBStringItemDef

public java.lang.String getMBStringItemDef(java.lang.String name,
                                           int itemNo,
                                           java.lang.String def)

Get the mbstring value of an occurrence of the item. If the item or its occurrence does not exist, the default value will be returned. The occurence number starts at 0.

Specified by:

getMBStringItemDef in interface Message

Parameters:

name - The name of the item.

itemNo - The occurrence number.

def - The default mbstring value.

Returns:

A mbstring value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getMessageItemDef

public JoltView32 getMessageItemDef(java.lang.String name,
                                    int itemNo,
                                    JoltView32 def)

Get the JoltView32 object of an occurrence of the item. If the item or its occurrence does not exist, the default object will be returned. The occurence number starts at 0.

Parameters:

name - The name of the item.

itemNo - The occurrence number.

def - The default JoltView32 object

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is not an input field.

getBooleanItemDef

public boolean getBooleanItemDef(java.lang.String name,
                                 int itemNo,
                                 boolean def)

Get an occurrence of a named item of boolean data type. The occurrence starts from 0. If it does not exist, the default value will be returned.

Parameters:

name - Name of the item.

itemNo - Occurrence number of the item.

def - Default value.

Returns:

A boolean value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.

getLongItemDef

public long getLongItemDef(java.lang.String name,
                           int itemNo,
                           long def)

Get an occurrence of a named item of long data type. The occurrence starts from 0. If it does not exist, the default value will be returned.

Parameters:

name - Name of the item.

itemNo - Occurrence number of the item.

def - Default value.

Returns:

A long value.

Throws:

java.lang.NoSuchFieldError - It is an invalid name.

java.lang.IllegalAccessError - It is an output item.

java.lang.IndexOutOfBoundsException - The itemNo for an alias field is not 0.

getInputs

public JoltMessage getInputs()

Get the input parameter message buffer.

See Also:

JoltMessage

getOutputs

public JoltMessage getOutputs()

Get the output parameter message buffer.

See Also:

JoltMessage