ilog.tgo.model

Class IltSNMPObjectState

java.lang.Object

ilog.tgo.model.IltObjectState

ilog.tgo.model.IltSNMPObjectState

All Implemented Interfaces:

ilog.cpl.model.internal.IlpCompositeAttributeValue, ilog.tgo.model.internal.IltStatePathValueCollection, ilog.tgo.model.internal.IltStateValueChangeNotifier, ilog.tgo.model.internal.IltStateValueCollection, ilog.tgo.model.internal.IltTypedStatePathValueCollection, ilog.tgo.model.internal.IltTypedStateValueCollection, ilog.tgo.model.state.event.IltAlarmSystemListener, ilog.tgo.model.state.event.IltStateSystemListener, Cloneable, EventListener

public class IltSNMPObjectState
extends IltObjectState
implements Cloneable

This class defines the state of a telecom object, according to the MIB-II specification for the SNMP protocol.

It uses the elements of the IltSNMP state system, as well as the extension provided by the IltMisc, IltPerformance and IltSAN state systems. Trap information is represented by the IltTrap alarm system.

This class therefore contains information about:

• the SNMP primary state of telecom objects,
• the list of secondary states defined in IltMisc, IltPerformance and IltSAN,
• the telecom object traps, embodied by an IltTrap.State instance.

See Also:

for the corresponding XML format

Field Summary

Fields

Modifier and Type	Field and Description
static IltObjectStateInfo	metainfo Contains metainformation about this IltObjectState class.

Fields inherited from interface ilog.cpl.model.internal.IlpCompositeAttributeValue

ATTRIBUTE_NAME_DELIMITER

Constructor Summary

Constructors

Constructor and Description
IltSNMPObjectState() Creates a new IltSNMPObjectState with the SNMP primary state initialized to DefaultState, and without statuses or traps.
IltSNMPObjectState(IltSNMP.State state) Creates a new IltSNMPObjectState with the given primary state value set, no statuses and no traps.

Method Summary

Modifier and Type	Method and Description
void	attach(IltObject obj) Attaches this object state to a given business object.
boolean	clear(IltState state) Removes the given state from the object state table.
Object	clone() Returns a copy of this state object.
void	detach(IltObject obj) Detaches this object state from a given business object.
boolean	equals(Object obj) Compares this object with another object.
IltState	getAlarmState() Returns the alarms part of the state.
static IltSNMP.State	GetDefaultState() The default SNMP state for a new object.
IltState	getPrimaryState() Returns the primary state present in this object state.
IltSNMP.State	getState() Returns the SNMP primary state of the telecom object.
IltSNMP.SystemInfo	getSystemInfo() Returns the MIB-II System Group information of this managed object.
IltState	getTrapState() Returns the trap part of the state.
boolean	has(IltState state) Tests whether this state contains a given constant state (defined in a state system).
void	reset() Removes all the states set in the object state.
boolean	set(IltState state) Sets the given state in the object state table.
static void	SetDefaultState(IltSNMP.State state) Sets the default primary state for a new object.
void	setState(IltSNMP.State state) Sets the SNMP primary state of the telecom object.
void	setSystemInfo(IltSNMP.SystemInfo info) Sets the MIB-II System Group information of this managed object.
void	setTrapState(IltTrap.State state) Sets the alarm state instance.

Methods inherited from class ilog.tgo.model.IltObjectState

addObjectStateListener, clear, endChangingObjectState, fireObjectStateChanged, fireObjectStateSet, get, get, getAggregate, getAggregate, getAlarmSystem, getAttributeValue, getBoolean, getBoolean, getFloat, getFloat, getInteger, getInteger, getListStrategy, getMapStrategy, getObjectStateInfo, getStateSystem, getStateValueTable, getSymbolic, getSymbolic, has, inverseStates, inverseValues, isValid, list, map, removeObjectStateListener, set, set, setAggregate, setAggregate, setAlarmSystem, setBoolean, setBoolean, setFloat, setFloat, setInteger, setInteger, setListStrategy, setMapStrategy, setStateSystem, setSymbolic, setSymbolic, severityAdded, severityRemoved, startChangingObjectState, stateAdded, stateRemoved, states, stateSystemAdded, stateSystemRemoved, values

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

metainfo

public static IltObjectStateInfo metainfo

Contains metainformation about this IltObjectState class.

Internal: do not use!

Constructor Detail

IltSNMPObjectState

public IltSNMPObjectState(IltSNMP.State state)

Creates a new IltSNMPObjectState with the given primary state value set, no statuses and no traps.

IltSNMPObjectState

public IltSNMPObjectState()

Creates a new IltSNMPObjectState with the SNMP primary state initialized to DefaultState, and without statuses or traps.

Method Detail

GetDefaultState

public static IltSNMP.State GetDefaultState()

The default SNMP state for a new object.

SetDefaultState

public static void SetDefaultState(IltSNMP.State state)

Sets the default primary state for a new object. This method also affects objects after a reset or a clear using the primary state.

Internal: do not use!

clone

public Object clone()

Returns a copy of this state object.

Overrides:

clone in class IltObjectState

equals

public boolean equals(Object obj)

Compares this object with another object.

Overrides:

equals in class IltObjectState

Internal: do not use!

getState

public IltSNMP.State getState()

Returns the SNMP primary state of the telecom object.

setState

public void setState(IltSNMP.State state)

Sets the SNMP primary state of the telecom object.

getAlarmState

public IltState getAlarmState()

Returns the alarms part of the state.

Overrides:

getAlarmState in class IltObjectState

Returns:

null

getTrapState

public IltState getTrapState()

Returns the trap part of the state.

Overrides:

getTrapState in class IltObjectState

Returns:

Normally an IltTrap.State

setTrapState

public void setTrapState(IltTrap.State state)

Sets the alarm state instance.

Internal: do not use!

getSystemInfo

public IltSNMP.SystemInfo getSystemInfo()

Returns the MIB-II System Group information of this managed object.

setSystemInfo

public void setSystemInfo(IltSNMP.SystemInfo info)

Sets the MIB-II System Group information of this managed object.

has

public boolean has(IltState state)

Description copied from class: IltObjectState

Tests whether this state contains a given constant state (defined in a state system).

Specified by:

has in interface ilog.tgo.model.internal.IltStateValueCollection

Overrides:

has in class IltObjectState

Parameters:

state - State being tested.

Returns:

true when the given state is part of the collection.

set

public boolean set(IltState state)

Sets the given state in the object state table.

Overrides:

set in class IltObjectState

clear

public boolean clear(IltState state)

Removes the given state from the object state table.

Specified by:

clear in interface ilog.tgo.model.internal.IltStateValueCollection

Overrides:

clear in class IltObjectState

Parameters:

state - State to be removed.

Returns:

true when the operation resulted in a modification of the collection.

reset

public void reset()

Removes all the states set in the object state.

Overrides:

reset in class IltObjectState

getPrimaryState

public IltState getPrimaryState()

Returns the primary state present in this object state.

Overrides:

getPrimaryState in class IltObjectState

Internal: do not use!

attach

public void attach(IltObject obj)

Description copied from class: IltObjectState

Attaches this object state to a given business object.

Overrides:

attach in class IltObjectState

See Also:

IltObject.setObjectState(IltObjectState)

Internal: do not use!

detach

public void detach(IltObject obj)

Description copied from class: IltObjectState

Detaches this object state from a given business object.

Overrides:

detach in class IltObjectState

See Also:

IltObject.setObjectState(IltObjectState)

Internal: do not use!