com.adventnet.tl1.message
Class TL1GeneralBlock

java.lang.Object
  |
  +--com.adventnet.tl1.message.TL1ParamBlock
        |
        +--com.adventnet.tl1.message.TL1GeneralBlock

All Implemented Interfaces:

java.io.Serializable

public class TL1GeneralBlock

extends TL1ParamBlock

This class represents the TL1 General Block which is a part of Staging Parameter Block in the TL1 Input Message. This class extends TL1ParamBlock and contains support parameters which affect the way the Input Message Command is executed in the NE.

TL1 Input Message block

Components of the TL1GeneralBlock

For example, the GeneralBlock in the input message,

TEST-FOR-GB::::12,2002-06-12,22-05-12,1,rtrvind:mpb;

is created as follows,

     TL1GeneralBlock gb = new TL1GeneralBlock();
     gb.setOrderNo(12);
     gb.setDate(new TL1Date(TL1Param.POSITION_DEFINED, 2002, 6, 12));
     gb.setTime(new TL1Time(TL1Message.INPUT_MESSAGE, TL1Param.POSITION_DEFINED, 22, 5, 12));
     gb.setContingencyFlag(true);
     gb.setIdr_ind("rtrvind");
 

See Also:

TL1Param, TL1Date, TL1Time, Serialized Form

Field Summary

static int	CONTINGENCY_FLAG_FALSE Constant for ContingencyFlag is false
static int	CONTINGENCY_FLAG_NOT_SET Constant for ContingencyFlag is not set
static int	CONTINGENCY_FLAG_TRUE Constant for ContingencyFlag id true

Constructor Summary

TL1GeneralBlock()
Default constructor that creates an instance of the TL1GeneralBlock object.

Method Summary

void	addParameter(TL1Param param) Overides its super method and destroys.
int	getContingencyFlag() Gets the contingency flag.
TL1Param	getDate() Gets the TL1Date as a TL1Param.
java.lang.String	getIdr_ind() Gets the Indirect Data Retrieval Indicator as a String.
int	getOrderNo() Gets the order number as an integer.
TL1Param	getTime() Gets the TL1Time as a TL1Param.
byte	getType() Gets the Parameter type as a byte value.
void	init() Reintializes all params in the TL1GeneralBlock object to its default value.
void	setContingencyFlag(boolean contFlag) Sets the contingency flag depending on the boolean value passed as argument.
void	setContingencyFlag(int contFlag) Sets the contingency flag depending on the int value passed as argument.
void	setDate(TL1Param date) Sets the TL1Date as a TL1Param.
void	setIdr_ind(java.lang.String idr_ind) Sets the value of Indirect Data Retrieval Indicator.
void	setOrderNo(int orderNo) Sets the order number with the given value.
void	setParameters(java.lang.String params) Overides its super method and destroys.
void	setParameters(java.util.Vector params) Overides its super method and destroys.
void	setSeparator(java.lang.String sep) Overides its super method and destroys.
void	setTime(TL1Param time) Sets the TL1Time as a TL1Param.
void	setType(byte type) Sets the Parameter type with the given value.

Methods inherited from class com.adventnet.tl1.message.TL1ParamBlock

clone, getParameter, getParameter, getParameterCount, getParameters, getSeparator, toExpandedString, toString

Methods inherited from class java.lang.Object

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

Field Detail

CONTINGENCY_FLAG_TRUE

public static final int CONTINGENCY_FLAG_TRUE

Constant for ContingencyFlag id true

CONTINGENCY_FLAG_FALSE

public static final int CONTINGENCY_FLAG_FALSE

Constant for ContingencyFlag is false

CONTINGENCY_FLAG_NOT_SET

public static final int CONTINGENCY_FLAG_NOT_SET

Constant for ContingencyFlag is not set

Constructor Detail

TL1GeneralBlock

public TL1GeneralBlock()

Default constructor that creates an instance of the TL1GeneralBlock object.

Method Detail

setOrderNo

public void setOrderNo(int orderNo)

Sets the order number with the given value.

Parameters:

orderNo - integer representing order number.

getOrderNo

public int getOrderNo()

Gets the order number as an integer.

Returns:

integer representing order number.

setDate

public void setDate(TL1Param date)

Sets the TL1Date as a TL1Param.

Parameters:

date - Instance of TL1Param.

See Also:

TL1Date

getDate

public TL1Param getDate()

Gets the TL1Date as a TL1Param.

Returns:

Instance of TL1Param.

See Also:

TL1Date

setTime

public void setTime(TL1Param time)

Sets the TL1Time as a TL1Param.

Parameters:

time - Instance of TL1Param.

See Also:

TL1Time

getTime

public TL1Param getTime()

Gets the TL1Time as a TL1Param.

Returns:

Instance of TL1Param.

See Also:

TL1Time

setContingencyFlag

public void setContingencyFlag(boolean contFlag)

Sets the contingency flag depending on the boolean value passed as argument.

Parameters:

contFlag - boolean value that represents the contingency flag.

setContingencyFlag

public void setContingencyFlag(int contFlag)

Sets the contingency flag depending on the int value passed as argument.

Parameters:

contFlag - int value representing the contingency flag. It can be one of,

• TL1GeneralBlock.CONTINGENCY_FLAG_TRUE
• TL1GeneralBlock.CONTINGENCY_FLAG_FALSE
• TL1GeneralBlock.CONTINGENCY_FLAG_NOT_SET

getContingencyFlag

public int getContingencyFlag()

Gets the contingency flag.

Returns:

int representing contingency flag.

setIdr_ind

public void setIdr_ind(java.lang.String idr_ind)

Sets the value of Indirect Data Retrieval Indicator.

Parameters:

idr_ind - String representing Indirect Data Retrieval Indicator.

getIdr_ind

public java.lang.String getIdr_ind()

Gets the Indirect Data Retrieval Indicator as a String.

Returns:

String representing Indirect Data Retrieval Indicator.

getType

public byte getType()

Gets the Parameter type as a byte value. This can be either NAME_DEFINED or POSITION_DEFINED defined in TL1Param.

Returns:

byte representing parameter type.

See Also:

TL1Param

setType

public void setType(byte type)

Sets the Parameter type with the given value. This can be either NAME_DEFINED or POSITION_DEFINED defined in TL1Param.

Parameters:

type - byte representing parameter type.

See Also:

TL1Param

setParameters

public void setParameters(java.util.Vector params)

Overides its super method and destroys. It cause no effect.

Overrides:

setParameters in class TL1ParamBlock

Following copied from class: com.adventnet.tl1.message.TL1ParamBlock

Parameters:

pmblock - Vector of TL1Param objects.

setParameters

public void setParameters(java.lang.String params)

Overides its super method and destroys. It cause no effect.

Overrides:

setParameters in class TL1ParamBlock

Following copied from class: com.adventnet.tl1.message.TL1ParamBlock

Parameters:

block - String of TL1Param objects. In the string the the TL1Params should be separated by (,). Each param can be name-defined(of the form name = value) or position-defined where the values are specified and the name is defined by it's position in the paramblock.

addParameter

public void addParameter(TL1Param param)

Overides its super method and destroys. It cause no effect.

Overrides:

addParameter in class TL1ParamBlock

Following copied from class: com.adventnet.tl1.message.TL1ParamBlock

Parameters:

param - TL1Param object.

See Also:

TL1Param

setSeparator

public void setSeparator(java.lang.String sep)

Overides its super method and destroys. It cause no effect.

Overrides:

setSeparator in class TL1ParamBlock

Following copied from class: com.adventnet.tl1.message.TL1ParamBlock

Parameters:

sep - String used to separate the TL1Params.

init

public void init()

Reintializes all params in the TL1GeneralBlock object to its default value.

Since:

TL1 API 3