Sonic Management API

com.sonicsw.mf.common.runtime
Interface IComponentState

All Superinterfaces:
java.lang.Comparable, IState

public interface IComponentState
extends IState

Indicates the runtime state of a component within its container.

See Also:
IContainerState, IContainerState.getComponentStates()

Field Summary
static short STATE_OFFLINE
          Indicates the component is offline.
static short STATE_ONLINE
          Indicates the component is online (in operational state).
static short STATE_STARTING
          Indicates the component is starting (but not yet operational).
static short STATE_STOPPING
          Indicates the component is stopping.
static java.lang.String[] STATE_TEXT
          Textual representations of component states (indexed by STATE_<> values).
static short STATE_UNKNOWN
          Indicates the component state cannot be determined.
 
Method Summary
 java.lang.String getLastErrorDescription()
          Get the textual description of the last uncleared condition with an error level < Level.INFO.
 int getLastErrorLevel()
          Get last error severity (uncleared condition with an error level < Level.INFO).
 
Methods inherited from interface com.sonicsw.mf.common.runtime.IState
compareTo, equals, getRuntimeIdentity, getState, getStateString
 

Field Detail

STATE_OFFLINE

static final short STATE_OFFLINE
Indicates the component is offline. The component has been created but it is currently not in an operational state.

See Also:
Constant Field Values

STATE_ONLINE

static final short STATE_ONLINE
Indicates the component is online (in operational state).

See Also:
Constant Field Values

STATE_STARTING

static final short STATE_STARTING
Indicates the component is starting (but not yet operational).

See Also:
Constant Field Values

STATE_STOPPING

static final short STATE_STOPPING
Indicates the component is stopping.

See Also:
Constant Field Values

STATE_TEXT

static final java.lang.String[] STATE_TEXT
Textual representations of component states (indexed by STATE_<> values).


STATE_UNKNOWN

static final short STATE_UNKNOWN
Indicates the component state cannot be determined.

See Also:
Constant Field Values
Method Detail

getLastErrorDescription

java.lang.String getLastErrorDescription()
Get the textual description of the last uncleared condition with an error level < Level.INFO.


getLastErrorLevel

int getLastErrorLevel()
Get last error severity (uncleared condition with an error level < Level.INFO).

See Also:
Level

Sonic Management API

Copyright © 2001-2012 Progress Software Corporation. All Rights Reserved.
HTML formatted on 13-Mar-2012.