com.pega.pegarules.pub.context
Interface Engine

public interface Engine

Field Summary

static java.lang.String	COPYRIGHT
static int	ENGINE_FAILED The PegaRULES Engine failed to start; please consult the log output for more information.
static int	ENGINE_RUNNING The PegaRULES Engine is already running; no action was taken by this call.
static int	ENGINE_STARTED The PegaRULES Engine was successfully started via this call.
static java.lang.String	VERSION

Method Summary

java.lang.Object	getNode() Retrieve the PRNode instance associated with the engine.
java.lang.String	getNodeUniqueID() Retrieve the unique id for this node
int	startEngine() Start the PegaRULES engine.
int	startEngineBootstrap() Start the PegaRULES engine with just the bootstrap rules loaded.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

VERSION

static final java.lang.String VERSION

See Also:

Constant Field Values

ENGINE_STARTED

static final int ENGINE_STARTED

The PegaRULES Engine was successfully started via this call.

See Also:

Constant Field Values

ENGINE_RUNNING

static final int ENGINE_RUNNING

The PegaRULES Engine is already running; no action was taken by this call.

See Also:

Constant Field Values

ENGINE_FAILED

static final int ENGINE_FAILED

The PegaRULES Engine failed to start; please consult the log output for more information.

See Also:

Constant Field Values

Method Detail

startEngine

int startEngine()

Start the PegaRULES engine. This function will start PegaRULES engine if it is not already running, and return an integer regarding its state. This function is intended for starting PegaRULES from an embedded state; if PegaRULES is running as a web application, PRStartup will ensure the engine is properly started.

Returns:

one of the ENGINE_* constants, representing the state of PegaRULES.

startEngineBootstrap

int startEngineBootstrap()

Start the PegaRULES engine with just the bootstrap rules loaded. This function will start PegaRULES engine if it is not already running, and return an integer regarding its state. Only basic facilities available, for example services are *not* started.

Returns:

one of the ENGINE_* constants, representing the state of PegaRULES.

getNode

java.lang.Object getNode()

Retrieve the PRNode instance associated with the engine. Note that the return type is Object, not PRNode because the latter references types not visible outside of the PegaRULES environment.

Returns:

Object representing PRNode instance or null if engine has not been started.

getNodeUniqueID

java.lang.String getNodeUniqueID()

Retrieve the unique id for this node

Returns:

id for this node or null if engine has not been started.