ilog.tgo.model
Class IltOSI.State

java.lang.Object
  ilog.tgo.model.IltState
      ilog.tgo.model.IltOSI.State

All Implemented Interfaces:

IltDecorationSource, IlWithProperties, Cloneable

Enclosing class:

IltOSI

public static class IltOSI.State
extends IltState
implements Cloneable

This class provides the building bricks of the state of a telecom object according to the OSI SMF 10164-2 standard. Such a state is a triplet; the values of this triplet provide the operational, usage and administrative aspects of the state, respectively.

The operational aspect of a state (or, simply, the operational state) is described by one of the two values Disabled or Enabled; these values are defined in the IltOSI.State.Operational class.

The usage aspect of a state (or, simply, the usage state) is described by one of the Idle, Active or Busy values; these values are defined in the IltOSI.State.Usage class.

The administrative aspect of a state (or, simply, administrative state) is described by one of the Unlocked, Shutting Down or Locked values; these values are defined in the IltOSI.State.Administrative class.

The IltOSI.State class therefore contains three attributes containing the values of these three classes.

Nested Class Summary

static class	IltOSI.State.Administrative
static class	IltOSI.State.Operational
static class	IltOSI.State.Usage

Field Summary

static IltStateInfo

metainfo Contains metainformation about this IltState class.

Fields inherited from class ilog.tgo.model.IltState

_message

Constructor Summary

IltOSI.State(ilog.tgo.model.internal.IltAggregateStateValue value)
Creates a new instance with given attributes.

IltOSI.State(IltOSI.State.Operational opState, IltOSI.State.Usage usState, IltOSI.State.Administrative admState)
Creates a new instance with given attributes.

Method Summary

Object	clone() Returns a copy of this object.
boolean	equals(Object obj) Compares two objects for equality.
IltOSI.State.Administrative	getAdministrativeState() Returns the administrative status of this instance.
IltOSI.State.Operational	getOperationalState() Returns the operational status of this instance.
IltOSI.State.Usage	getUsageState() Returns the usage status of this instance.
ilog.tgo.model.internal.IltAggregateStateValue	getValue()
void	list(IlpContext context, IltStateListing listing, Object value) Generates a plain text listing of the state.
void	setAdministrativeState(IltOSI.State.Administrative admState) Sets the administrative status of this instance.
void	setNotifier(ilog.tgo.model.internal.IltStateValueChangeNotifier notifier) Sets the notifier instance.
void	setOperationalState(IltOSI.State.Operational opState) Sets the operational status of this instance.
void	setUsageState(IltOSI.State.Usage usState) Sets the usage status of this instance.

Methods inherited from class ilog.tgo.model.IltState

copy, CreateNameFilter, CreateStateFilter, createValue, getAliases, getAllPaths, getAltName, getDefault, getDescription, getName, getProperty, getStateInfo, getToolTipText, getToolTipText, hasDefault, hasDescription, hashCode, intern, isInside, IsPropertyTransient, isValid, removeProperty, setAltName, setDescription, setMessage, setName, setProperty, SetPropertyTransient, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

metainfo

public static IltStateInfo metainfo

Contains metainformation about this IltState class.

Internal method or field: do not use!

Constructor Detail

IltOSI.State

public IltOSI.State(IltOSI.State.Operational opState,
                    IltOSI.State.Usage usState,
                    IltOSI.State.Administrative admState)

Creates a new instance with given attributes.

Parameters:

opState - the operational aspect

usState - the usage aspect

admState - the administrative aspect

IltOSI.State

public IltOSI.State(ilog.tgo.model.internal.IltAggregateStateValue value)

Creates a new instance with given attributes.

Internal method or field: do not use!

Method Detail

getValue

public ilog.tgo.model.internal.IltAggregateStateValue getValue()

Internal method or field: do not use!

setNotifier

public void setNotifier(ilog.tgo.model.internal.IltStateValueChangeNotifier notifier)

Sets the notifier instance.

Internal method or field: do not use!

getOperationalState

public IltOSI.State.Operational getOperationalState()

Returns the operational status of this instance.

setOperationalState

public void setOperationalState(IltOSI.State.Operational opState)

Sets the operational status of this instance.

getUsageState

public IltOSI.State.Usage getUsageState()

Returns the usage status of this instance.

setUsageState

public void setUsageState(IltOSI.State.Usage usState)

Sets the usage status of this instance.

getAdministrativeState

public IltOSI.State.Administrative getAdministrativeState()

Returns the administrative status of this instance.

setAdministrativeState

public void setAdministrativeState(IltOSI.State.Administrative admState)

Sets the administrative status of this instance.

list

public void list(IlpContext context,
                 IltStateListing listing,
                 Object value)

Generates a plain text listing of the state.

Overrides:

list in class IltState

Internal method or field: do not use!

clone

public Object clone()

Returns a copy of this object.

Overrides:

clone in class Object

equals

public boolean equals(Object obj)

Compares two objects for equality. Two IltOSI.State are considered equal if their attributes have the same respective values.

Overrides:

equals in class IltState