com.adventnet.management.config.tl1
Class TL1Attribute

java.lang.Object
  com.adventnet.management.config.xml.BaseElement
      com.adventnet.management.config.xml.Attribute
          com.adventnet.management.config.tl1.TL1Attribute

All Implemented Interfaces:

java.io.Serializable

public class TL1Attribute
extends Attribute
implements java.io.Serializable

This class represents TL1 Messages that are to be configured for the specified Network Elements.

It consists of the following attributes.
CommandCode - Specifies the action that needs to be initiated on the TL1 NE (Network Element). It contains the verb and optional modifiers
TargetID - Performs network routing tasks
AccessID - Identifies a particular entity in the NE
GeneralBlock - Specifies the GeneralBlock Parameters (Delay Activation, Contingency Flag and Data Retrieval) which affects the way of execution of TL1Command in the NE
MessagePayLoadBlock - Specifies the payload or subject of the message consisting of one or more data blocks.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.adventnet.management.config.xml.BaseElement

element, isServer

Constructor Summary

TL1Attribute()
Constructs a TL1Attribute by initializing an empty Element of name "Attribute".

TL1Attribute(Attribute attribute)
Constructs a TL1Attribute from Attribute's Element.

TL1Attribute(java.lang.String commandCode)
Constructs a TL1Attribute from CommandCode alone.

TL1Attribute(java.lang.String commandCode, java.lang.String targetID)
Constructs a TL1Attribute from CommandCode and TargetID.

TL1Attribute(java.lang.String commandCode, java.lang.String targetID, java.lang.String accessID)
Constructs a TL1Attribute from CommandCode, TargetID and accessID.

TL1Attribute(java.lang.String commandCode, java.lang.String targetID, java.lang.String accessID, java.lang.String generalBlock)
Constructs a TL1Attribute from CommandCode, TargetID , accessID and generalBlock.

TL1Attribute(java.lang.String commandCode, java.lang.String targetID, java.lang.String accessID, java.lang.String generalBlock, java.lang.String messagePayLoadBlock)
Constructs a TL1Attribute from CommandCode, TargetID, accessID, generalBlock and MessagePayLoadBlock.

Method Summary

java.lang.String	getAccessID() Returns the AccessID which identifies the particular entity in the Network Element.
java.lang.String	getCommandCode() Returns the command code of the TL1Attribute.
java.lang.String	getGeneralBlock() Returns the general block parameters for the TL1 Message.
java.lang.String	getIdentifier() Returns the CommandCode, which used is by ConfigServer for refering this attribute.
java.lang.String	getMessagePayLoadBlock() Returns the payload of the TL1Message which consists of one or more data values.
java.lang.String	getTargetID() Returns the TargetIdentification code of the TL1 Command.
void	setAccessID(java.lang.String accessID) Specifies the particular entity in the NetworkElement.
void	setCommandCode(java.lang.String commandCode) Specifies the action to be taken of the NE.
void	setGeneralBlock(java.lang.String generalBlock) Specifies the GeneralBlock Parameters (Delay Activation, Contingency Flag and Data Retrieval) which affects the way of execution of TL1Command in the NE.
void	setMessagePayLoadBlock(java.lang.String messagePayLoadBlock) Specifies the payload or subject of the message consisting of one or more data blocks.
void	setTargetID(java.lang.String targetID) Specifies the network routing tasks for the TL1 Command.

Methods inherited from class com.adventnet.management.config.xml.Attribute

getAttributeList, getAttributeType, getUserAttributes, setAttributeList, setAttributeType, setUserAttributes

Methods inherited from class com.adventnet.management.config.xml.BaseElement

addSubTag, getAttribute, getElement, getProperties, getSubTagsByName, hasAttribute, removeSubTagsByName, setAttribute, setProperties, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TL1Attribute

public TL1Attribute()

Constructs a TL1Attribute by initializing an empty Element of name "Attribute".

TL1Attribute

public TL1Attribute(Attribute attribute)

Constructs a TL1Attribute from Attribute's Element.

Parameters:

attribute - an Attribute object.

TL1Attribute

public TL1Attribute(java.lang.String commandCode)

Constructs a TL1Attribute from CommandCode alone. Modifiers can also be included with verb like ACT_USER, RTRV-ALM-EQPT etc

Parameters:

commandCode - Specifies the action to be taken on the NE.

TL1Attribute

public TL1Attribute(java.lang.String commandCode,
                    java.lang.String targetID)

Constructs a TL1Attribute from CommandCode and TargetID. Target Identification Code provides the capability for performing the network routing tasks.

Parameters:

commandCode - Specifies the action to be taken on the NE.

targetID - Specifies TL1 Command Routing.

TL1Attribute

public TL1Attribute(java.lang.String commandCode,
                    java.lang.String targetID,
                    java.lang.String accessID)

Constructs a TL1Attribute from CommandCode, TargetID and accessID. AccessID identifies a particular entity in the Network Element.

Parameters:

commandCode - Specifies the action to be taken on the NE.

targetID - Specifies TL1 Command Routing.

accessID - Identifies the particular entity in the NE.

TL1Attribute

public TL1Attribute(java.lang.String commandCode,
                    java.lang.String targetID,
                    java.lang.String accessID,
                    java.lang.String generalBlock)

Constructs a TL1Attribute from CommandCode, TargetID , accessID and generalBlock. GeneralBlock Parameters affect the way in which the command is to be executed on the NE.

Parameters:

commandCode - Specifies the action to be taken on the NE.

targetID - Specifies TL1 Command Routing.

accessID - Identifies the particular entity.

generalBlock - Consists of Delay Activation,Contigency Flag and DataRetrieval Indicator components.

TL1Attribute

public TL1Attribute(java.lang.String commandCode,
                    java.lang.String targetID,
                    java.lang.String accessID,
                    java.lang.String generalBlock,
                    java.lang.String messagePayLoadBlock)

Constructs a TL1Attribute from CommandCode, TargetID, accessID, generalBlock and MessagePayLoadBlock. MessagePayLoadBlock contains the subject of the messsage.

Parameters:

commandCode - Specifies the action to be taken on the NE.

targetID - Specifies TL1 Command Routing.

accessID - Identifies the particular entity.

generalBlock - Consists of Delay Activation,Contigency Flag and DataRetrieval Indicator components.

messagePayLoadBlock - Consists of comma separated data items for the message.

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Returns the CommandCode, which used is by ConfigServer for refering this attribute.

Overrides:

getIdentifier in class Attribute

Returns:

an identifier for this attribute.

getCommandCode

public java.lang.String getCommandCode()

Returns the command code of the TL1Attribute.

Returns:

a String representing the command code value

See Also:

setCommandCode(String)

setCommandCode

public void setCommandCode(java.lang.String commandCode)

Specifies the action to be taken of the NE.

Parameters:

commandCode - command verb along with modifiers.

See Also:

getCommandCode()

getTargetID

public java.lang.String getTargetID()

Returns the TargetIdentification code of the TL1 Command.

Returns:

a String representing the target ID value

See Also:

setTargetID(String)

setTargetID

public void setTargetID(java.lang.String targetID)

Specifies the network routing tasks for the TL1 Command.

Parameters:

targetID - a String specifying the target ID value

See Also:

getTargetID()

getAccessID

public java.lang.String getAccessID()

Returns the AccessID which identifies the particular entity in the Network Element.

Returns:

a String representing the access ID value

See Also:

setAccessID(String)

setAccessID

public void setAccessID(java.lang.String accessID)

Specifies the particular entity in the NetworkElement.

Parameters:

accessID - a String specifying the access ID value

See Also:

getAccessID()

getGeneralBlock

public java.lang.String getGeneralBlock()

Returns the general block parameters for the TL1 Message.

Returns:

a String representing the general block value

See Also:

setGeneralBlock(String)

setGeneralBlock

public void setGeneralBlock(java.lang.String generalBlock)

Specifies the GeneralBlock Parameters (Delay Activation, Contingency Flag and Data Retrieval) which affects the way of execution of TL1Command in the NE.

Parameters:

generalBlock - a String specifying the general block value

See Also:

getGeneralBlock()

getMessagePayLoadBlock

public java.lang.String getMessagePayLoadBlock()

Returns the payload of the TL1Message which consists of one or more data values.

Returns:

a String representing the message pay load block value

See Also:

setMessagePayLoadBlock(String)

setMessagePayLoadBlock

public void setMessagePayLoadBlock(java.lang.String messagePayLoadBlock)

Specifies the payload or subject of the message consisting of one or more data blocks.

Parameters:

messagePayLoadBlock - a String specifying the message pay load block value

See Also:

getMessagePayLoadBlock()