com.adventnet.tl1.message
Class TL1Param

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

public class TL1Param

extends java.lang.Object

This class represents a TL1 parameter object. The two parameter types are

• NAME_DEFINED
• POSITION_DEFINED

Each TL1Param object will consists of a name and a value. The name field is optional for POSITION_DEFINED type.

Field Summary

static byte	NAME_DEFINED Constant that represents a name defined parameter type
static byte	POSITION_DEFINED Constant that represents a position defined parameter type

Constructor Summary

TL1Param()
Default constructor that creates an instance of this Parameter object.

TL1Param(byte type, java.lang.String name, java.lang.String value)
Constructor that creates an instance of this Parameter object and initializes the parameter type, parameter name and parameter value.

TL1Param(java.lang.String name)
Deprecated. Since AdventNetTL1 API 2.0. Use Constructor with arguments type,parameter name and parameter value.

Method Summary

java.lang.String	getName() Deprecated. Since AdventNetTL1 API 2.0. Use getParamName()
java.lang.String	getParamName() Gets the name for this parameter object.
TL1ParamValue	getParamValue() Deprecated. Since AdventNetTL1 API 2.0. Use getParamValueString().
java.lang.String	getParamValueString() Gets the value for this parmeter object.
byte	getType() Gets the type of this parameter object.
void	setName(java.lang.String name) Deprecated. Since AdventNetTL1 API 2.0. Use setParamName (java.lang.String name)
void	setParamName(java.lang.String name) Sets the name with the given value for this parameter object.
void	setParamValue(TL1ParamValue paramValue) Deprecated. Since AdventNetTL1 API 2.0. Use setParamValueString(java.lang.String value).
void	setParamValueString(java.lang.String paramValue) Sets the value of this parameter object with the given value.
void	setType(byte type) Sets the type of this parameter object.
java.lang.String	toString() Returns the string format of this TL1Param object.

Methods inherited from class java.lang.Object

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

Field Detail

NAME_DEFINED

public static final byte NAME_DEFINED

Constant that represents a name defined parameter type

POSITION_DEFINED

public static final byte POSITION_DEFINED

Constant that represents a position defined parameter type

Constructor Detail

TL1Param

public TL1Param()

Default constructor that creates an instance of this Parameter object.

TL1Param

public TL1Param(java.lang.String name)

Deprecated. Since AdventNetTL1 API 2.0. Use Constructor with arguments type,parameter name and parameter value.

Constructor that creates an instance of this Parameter object and initializes the parameter name with the given value.

Parameters:

name - String representing the parameter name.

See Also:

TL1Param(byte type, String name, String value)

TL1Param

public TL1Param(byte type,
                java.lang.String name,
                java.lang.String value)

Constructor that creates an instance of this Parameter object and initializes the parameter type, parameter name and parameter value.

Parameters:

type - byte representing parameter type, can be either NAME_DEFINED or POSITION_DEFINED.

name - String representing the parameter name. In case of position defined this parameter name is ignored.

value - String representing the parameter value.

Method Detail

setParamName

public void setParamName(java.lang.String name)

Sets the name with the given value for this parameter object.

Parameters:

name - String representing this parameter name.

getParamName

public java.lang.String getParamName()

Gets the name for this parameter object.

Returns:

String representing this parameter name.

setName

public void setName(java.lang.String name)

Deprecated. Since AdventNetTL1 API 2.0. Use setParamName (java.lang.String name)

Sets the name with the given value for this parameter object.

Parameters:

name - String representing the parameter name.

See Also:

setParamName(java.lang.String)

getName

public java.lang.String getName()

Deprecated. Since AdventNetTL1 API 2.0. Use getParamName()

Gets the name for this parameter object.

Returns:

String representing this parameter name.

See Also:

getParamName()

setType

public void setType(byte type)

Sets the type of this parameter object.

Parameters:

type - byte representing parameter type can be either NAME_DEFINED or POSITION_DEFINED.

getType

public byte getType()

Gets the type of this parameter object. It

Returns:

byte representing the parameter type can be either NAME_DEFINED or POSITION_DEFINED.

getParamValue

public TL1ParamValue getParamValue()

Deprecated. Since AdventNetTL1 API 2.0. Use getParamValueString().

Gets the value for this parmeter object.

Returns:

TL1ParamValue object.

See Also:

getParamValueString()

getParamValueString

public java.lang.String getParamValueString()

Gets the value for this parmeter object.

Returns:

Parameter value as a String.

setParamValue

public void setParamValue(TL1ParamValue paramValue)

Deprecated. Since AdventNetTL1 API 2.0. Use setParamValueString(java.lang.String value).

Sets the value of this parameter object with the given value.

Parameters:

paramValue - TL1ParamValue object to set.

See Also:

setParamValueString(java.lang.String)

setParamValueString

public void setParamValueString(java.lang.String paramValue)

Sets the value of this parameter object with the given value.

Parameters:

paramValue - TL1ParamValue object to set.

See Also:

TL1ParamValue

toString

public java.lang.String toString()

Returns the string format of this TL1Param object.

Overrides:

toString in class java.lang.Object

Returns:

The string representation of this object