IltOSIObjectState (Rogue Wave JViews 9.0 API)

java.lang.Object
- ilog.tgo.model.IltObjectState
- - ilog.tgo.model.IltOSIObjectState

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 IltOSIObjectState
extends IltObjectState
implements Cloneable
```
An instance of this class is the state of some telecom object, as defined by the OSI SMF 10164-2 standard.
It uses the elements of the IltOSIstate system, and also the extension provided by the IltMisc state system, the IltPerformance state system, the IltSAN state system and the alarm model provided by the IltAlarm state system.
This class therefore contains three attributes:
- the OSI state of the telecom object, embodied by an IltOSI.State instance,
- the list of statuses of the telecom object, whether IltOSI.Availability, IltOSI.Control, IltOSI.Procedural, IltOSI.Standby instances, IltMisc.SecState instances, IltPerformance.SecState instances or IltSAN instances,
- the telecom object alarms, embodied by an IltAlarm.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

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

Constructor Summary

Constructors
Constructor and Description
`IltOSIObjectState()` Creates a new `IltOSIObjectState` with the OSI state initialized to `DefaultState`, no statuses and no alarms.
`IltOSIObjectState(IltOSI.State state)` Creates a new `IltOSIObjectState` with the given OSI state, no statuses and no alarms.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addStatus(IltState state)` Adds `state` to the list of statuses of the telecom object.
`boolean`	`clear(IltState state)` Removes a given constant state (defined in a state system) from this state.
`Object`	`clone()` Returns a copy of this state object.
`IltState`	`getAlarmState()` Returns the alarms part of the state.
`static IltOSI.State`	`GetDefaultState()` Returns the default OSI state for a new object.
`IltState`	`getPrimaryState()` Returns the primary state present in this object state.
`IltOSI.State`	`getState()` Returns the OSI status of the telecom object.
`Enumeration`	`getStatuses()` Returns an enumeration of the statuses of the telecom object listed.
`boolean`	`has(IltState state)` Tests whether this state contains a given constant state (defined in a state system).
`boolean`	`hasStatus(IltState state)` Tests whether a given `state` is among the statuses of the telecom object listed.
`void`	`removeAllStatuses()` Removes all secondary states currently set in this instance.
`boolean`	`removeStatus(IltState state)` Removes `state` from the list of statuses of the telecom object.
`void`	`reset()` Resets all the state values for the telecom object.
`boolean`	`set(IltState state)` Adds a given constant state (defined in a state system) to this state.
`void`	`setAlarmState(IltAlarm.State state)` Sets the alarm state instance.
`static void`	`SetDefaultState(IltOSI.State state)` Sets the default OSI state for a new object.
`void`	`setState(IltOSI.State state)` Sets the OSI state of the telecom object.
`void`	`setStatuses(Enumeration states)` Replaces the list of statuses with the contents of a given enumeration.

Methods inherited from class ilog.tgo.model.IltObjectState
addObjectStateListener, attach, clear, detach, endChangingObjectState, equals, fireObjectStateChanged, fireObjectStateSet, get, get, getAggregate, getAggregate, getAlarmSystem, getAttributeValue, getBoolean, getBoolean, getFloat, getFloat, getInteger, getInteger, getListStrategy, getMapStrategy, getObjectStateInfo, getStateSystem, getStateValueTable, getSymbolic, getSymbolic, getTrapState, 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
  - IltOSIObjectState
```
public IltOSIObjectState(IltOSI.State state)
```
    Creates a new IltOSIObjectState with the given OSI state, no statuses and no alarms.
  - IltOSIObjectState
```
public IltOSIObjectState()
```
    Creates a new IltOSIObjectState with the OSI state initialized to DefaultState, no statuses and no alarms.
- Method Detail
  - GetDefaultState
```
public static IltOSI.State GetDefaultState()
```
    Returns the default OSI state for a new object.
  - SetDefaultState
```
public static void SetDefaultState(IltOSI.State state)
```
    Sets the default OSI 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
  - getState
```
public IltOSI.State getState()
```
    Returns the OSI status of the telecom object.
  - setState
```
public void setState(IltOSI.State state)
```
    Sets the OSI state of the telecom object. state is not copied.
  - hasStatus
```
public boolean hasStatus(IltState state)
```
    Tests whether a given state is among the statuses of the telecom object listed.
  - addStatus
```
public boolean addStatus(IltState state)
```
    Adds state to the list of statuses of the telecom object.
  - removeStatus
```
public boolean removeStatus(IltState state)
```
    Removes state from the list of statuses of the telecom object.
  - removeAllStatuses
```
public void removeAllStatuses()
```
    Removes all secondary states currently set in this instance.
  - getStatuses
```
public Enumeration getStatuses()
```
    Returns an enumeration of the statuses of the telecom object listed.
    
    Returns:
    
    an enumeration of IltState
  - setStatuses
```
public void setStatuses(Enumeration states)
```
    Replaces the list of statuses with the contents of a given enumeration.
    
    Parameters:
    
    states - an enumeration of IltState
  - getAlarmState
```
public IltState getAlarmState()
```
    Returns the alarms part of the state.
    
    Overrides:
    
    getAlarmState in class IltObjectState
    
    Returns:
    
    an IltAlarm.State
  - setAlarmState
```
public void setAlarmState(IltAlarm.State state)
```
    Sets the alarm state instance.
    
    Internal: do not use!
  - 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)
```
    Description copied from class: IltObjectState
    
    Adds a given constant state (defined in a state system) to this state.
    
    Overrides:
    
    set in class IltObjectState
  - clear
```
public boolean clear(IltState state)
```
    Description copied from class: IltObjectState
    
    Removes a given constant state (defined in a state system) from this state.
    
    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()
```
    Description copied from class: IltObjectState
    
    Resets all the state values for the telecom object. When applicable, the state values are set to their default values.
    
    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!

Class IltOSIObjectState

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class ilog.tgo.model.IltObjectState

Methods inherited from class java.lang.Object

Field Detail

metainfo

Constructor Detail

IltOSIObjectState

IltOSIObjectState

Method Detail

GetDefaultState

SetDefaultState

clone

getState

setState

hasStatus

addStatus

removeStatus

removeAllStatuses

getStatuses

setStatuses

getAlarmState

setAlarmState

has

set

clear

reset

getPrimaryState