com.crystaldecisions.sdk.plugin.desktop.server
Class ExpectedRunState

java.lang.Object
  com.crystaldecisions.sdk.plugin.desktop.server.ExpectedRunState

public class ExpectedRunState
extends java.lang.Object

This class contains constants and methods for representing the expected run state of a server in an SAP BusinessObjects Enterprise deployment.

See Also:

IServerBase.getExpectedRunState(), IServerBase.setExpectedRunState(com.crystaldecisions.sdk.plugin.desktop.server.ExpectedRunState)

Field Summary

static ExpectedRunState	INVALID Specifies that the expected state of the server is invalid due to a configuration error.
static ExpectedRunState	RECYCLE Specifies that the expected state of the server is recycle.
static ExpectedRunState	RESTART Specifies that the expected state of the server is restarting.
static ExpectedRunState	RUNNING Specifies that the expected state of the server is running.
static ExpectedRunState	STOPNOW Specifies that the expected state of the server is immediate shutdown.
static ExpectedRunState	STOPPED Specifies that the expected state of the server is stopped.
static ExpectedRunState	UNMANAGED For internal use only.

Method Summary

static ExpectedRunState	fromInteger(int i) Returns the expected run state object that corresponds to the specified integer.
static ExpectedRunState	fromString(java.lang.String s) Returns the expected run state object that corresponds to the specified string.
static ExpectedRunState[]	GetAllExpectedRunStates()
int	toInteger() Returns the expected run state as an integer.
java.lang.String	toString() Returns the expected run state as a string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RUNNING

public static final ExpectedRunState RUNNING

Specifies that the expected state of the server is running.

RESTART

public static final ExpectedRunState RESTART

Specifies that the expected state of the server is restarting.

STOPPED

public static final ExpectedRunState STOPPED

Specifies that the expected state of the server is stopped.

UNMANAGED

public static final ExpectedRunState UNMANAGED

For internal use only.

STOPNOW

public static final ExpectedRunState STOPNOW

Specifies that the expected state of the server is immediate shutdown.

RECYCLE

public static final ExpectedRunState RECYCLE

Specifies that the expected state of the server is recycle.

INVALID

public static final ExpectedRunState INVALID

Specifies that the expected state of the server is invalid due to a configuration error.

Method Detail

GetAllExpectedRunStates

public static ExpectedRunState[] GetAllExpectedRunStates()

toString

public java.lang.String toString()

Returns the expected run state as a string. Possible values are:

Invalid	The server is currently in an invalid state due to a configuration error.
Stopped	The expected state of the server is stopped.
Running	The expected state of the server is running.
Restart	The expected state of the server is restarting.
Unmanaged	The server is not being managed by the Server Intelligence Agent.
StopNow	The expected state of the server is immediate shutdown.
Recycle	The expected state of the server is recycle.

Overrides:

toString in class java.lang.Object

fromString

public static ExpectedRunState fromString(java.lang.String s)

Returns the expected run state object that corresponds to the specified string.

Parameters:

s - the expected run state string. Possible values are:

Invalid	The server is currently in an invalid state due to a configuration error.
Stopped	The expected state of the server is stopped.
Running	The expected state of the server is running.
Restart	The expected state of the server is restarting.
StopNow	The expected state of the server is immediate shutdown.
Recycle	The expected state of the server is recycle.

If you specify an invalid value, this method returns an ExpectedRunState object with the Invalid state.

Returns:

ExpectedRunState object

fromInteger

public static ExpectedRunState fromInteger(int i)

Returns the expected run state object that corresponds to the specified integer.

Parameters:

i - the expected run state integer. Possible values are:

-1	The server is currently in an invalid state due to a configuration error.
0	The expected state of the server is stopped.
1	The expected state of the server is running.
2	The expected state of the server is restarting.
4	The expected state of the server is immediate shutdown.
5	The expected state of the server is recycle.

If you specify an invalid value, this method returns an ExpectedRunState object with the Invalid state.

Returns:

ExpectedRunState object

toInteger

public int toInteger()

Returns the expected run state as an integer. Possible values are:

-1	The server is currently in an invalid state due to a configuration error.
0	The expected state of the server is stopped.
1	The expected state of the server is running.
2	The expected state of the server is restarting.
3	The server is not being managed by the Server Intelligence Agent.
4	The expected state of the server is immediate shutdown.
5	The expected state of the server is recycle.