com.adventnet.tl1.message
Class TL1GeneralBlock

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

public class TL1GeneralBlock

extends java.lang.Object

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

TL1 Input Message block

Components of the TL1GeneralBlock

See Also:

TL1Date, TL1Time

Field Summary

(package private) java.lang.String	CF
static int	CONTINGENCY_FLAG_FALSE Constant for ContingencyFlag
static int	CONTINGENCY_FLAG_NOT_SET Constant for ContingencyFlag
static int	CONTINGENCY_FLAG_TRUE Constant for ContingencyFlag
(package private) java.lang.String	DATE
(package private) java.lang.String	ORDERNO
(package private) java.lang.String	RTRVIND
(package private) java.lang.String	TIME

Constructor Summary

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

Method Summary

int	getContingencyFlag() Get the contingency flag.
TL1Date	getDate() Get TL1Date object.
java.lang.String	getIdr_ind() Get the Indirect Data Retrieval Indicator as a String.
int	getOrderNo() Get the order number as an integer.
TL1Time	getTime() Get the TL1Time object.
byte	getType() Get the Paramater Type as a byte value.
void	setContingencyFlag(boolean contFlag) Set the contingency flag depending on the boolean value passed as argument.
void	setContingencyFlag(int contFlag) Set the contingency flag depending on the boolean value passed as argument.
void	setDate(TL1Date date) Set the TL1Date object.
void	setIdr_ind(java.lang.String idr_ind) To set the Indirect Data Retrieval Indicator.
void	setOrderNo(int orderNo) Set the order number with the given value.
void	setTime(TL1Time time) Set TL1Time object.
void	setType(byte type) Set the Paramater Type with the given value.
java.lang.String	toString() Convert this object to a stringified form.

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ORDERNO

final java.lang.String ORDERNO

DATE

final java.lang.String DATE

TIME

final java.lang.String TIME

CF

final java.lang.String CF

RTRVIND

final java.lang.String RTRVIND

CONTINGENCY_FLAG_TRUE

public static int CONTINGENCY_FLAG_TRUE

Constant for ContingencyFlag

CONTINGENCY_FLAG_FALSE

public static int CONTINGENCY_FLAG_FALSE

Constant for ContingencyFlag

CONTINGENCY_FLAG_NOT_SET

public static int CONTINGENCY_FLAG_NOT_SET

Constant for ContingencyFlag

Constructor Detail

TL1GeneralBlock

public TL1GeneralBlock()

Default constructor that creates an instance of the TL1GeneralBlock object.

Method Detail

setIdr_ind

public void setIdr_ind(java.lang.String idr_ind)

To set the Indirect Data Retrieval Indicator.

Parameters:

idr_ind - String representing Indirect Data Retrieval Indicator.

getIdr_ind

public java.lang.String getIdr_ind()

Get the Indirect Data Retrieval Indicator as a String.

Returns:

String representing Indirect Data Retrieval Indicator.

setDate

public void setDate(TL1Date date)

Set the TL1Date object.

Parameters:

date - TL1Date object.

See Also:

TL1Date

getDate

public TL1Date getDate()

Get TL1Date object.

Returns:

TL1Date object.

See Also:

TL1Date

setTime

public void setTime(TL1Time time)

Set TL1Time object.

Parameters:

time - TL1Time object.

See Also:

TL1Time

getTime

public TL1Time getTime()

Get the TL1Time object.

Returns:

TL1Time object.

See Also:

TL1Time

setOrderNo

public void setOrderNo(int orderNo)

Set the order number with the given value.

Parameters:

orderNo - integer representing order number.

getOrderNo

public int getOrderNo()

Get the order number as an integer.

Returns:

integer representing order number.

getType

public byte getType()

Get the Paramater 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)

Set the Paramater 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

setContingencyFlag

public void setContingencyFlag(boolean contFlag)

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

Parameters:

contFlag - boolean

setContingencyFlag

public void setContingencyFlag(int contFlag)

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

Parameters:

contFlag - int value. (TL1GeneralBlock.CONTINGENCY_FLAG_TRUE, TL1GeneralBlock.CONTINGENCY_FLAG_FALSE).

getContingencyFlag

public int getContingencyFlag()

Get the contingency flag.

Returns:

int representing contingency flag.

toString

public java.lang.String toString()

Convert this object to a stringified form.

Overrides:

toString in class java.lang.Object

Returns:

String representation of this object.