jadex.bridge.service.types.cms

Interface IComponentDescription

All Known Implementing Classes:

CMSComponentDescription

public interface IComponentDescription

A description of a component, i.e. information about the execution state, component type, etc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROCESSINGSTATE_IDLE The idle processing state.
static String	PROCESSINGSTATE_READY The ready processing state.
static String	PROCESSINGSTATE_RUNNING The running processing state.
static String	STATE_ACTIVE Predefined value "active" for slot state.
static String	STATE_INITIATED Predefined value "initiated" for slot state.
static String	STATE_SUSPENDED Predefined value "suspended" for slot state.
static String	STATE_TERMINATED Predefined value "terminated" for slot state.
static String	STATE_TRANSIT Predefined value "transit" for slot state.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getAutoShutdown() Get the auto shutdown flag.
String[]	getBreakpoints() Get the enabled breakpoints (if any).
Cause	getCause() Get the cause for creating the component.
long	getCreationTime() Get the creation time.
IComponentIdentifier	getCreator() Get the creator of this component.
Boolean	getDaemon() Is the component a daemon.
String	getLocalType() Get the local type name of a component (defined in the parent).
Boolean	getMaster() Is the component a master.
String	getModelName() Get the model name.
IMonitoringService.PublishEventLevel	getMonitoring() Get the monitoring flag.
IComponentIdentifier	getName() Get the identifier of the component.
String	getOwnership() Get the ownership string of the component.
IResourceIdentifier	getResourceIdentifier() Get the resource identifier.
String	getState() Get the execution state of the component.
Boolean	getSynchronous() Get the synchronous flag.
String	getType() Get the component type.

Field Detail

STATE_INITIATED

static final String STATE_INITIATED

Predefined value "initiated" for slot state.

See Also:

Constant Field Values

STATE_TRANSIT

static final String STATE_TRANSIT

Predefined value "transit" for slot state.

See Also:

Constant Field Values

STATE_ACTIVE

static final String STATE_ACTIVE

Predefined value "active" for slot state.

See Also:

Constant Field Values

STATE_SUSPENDED

static final String STATE_SUSPENDED

Predefined value "suspended" for slot state.

See Also:

Constant Field Values

STATE_TERMINATED

static final String STATE_TERMINATED

Predefined value "terminated" for slot state.

See Also:

Constant Field Values

PROCESSINGSTATE_READY

static final String PROCESSINGSTATE_READY

The ready processing state.

See Also:

Constant Field Values

PROCESSINGSTATE_RUNNING

static final String PROCESSINGSTATE_RUNNING

The running processing state.

See Also:

Constant Field Values

PROCESSINGSTATE_IDLE

static final String PROCESSINGSTATE_IDLE

The idle processing state.

See Also:

Constant Field Values

Method Detail

getName

IComponentIdentifier getName()

Get the identifier of the component.

Returns:

The component identifier.

getModelName

String getModelName()

Get the model name.

Returns:

The model name.

getResourceIdentifier

IResourceIdentifier getResourceIdentifier()

Get the resource identifier.

Returns:

The resource identifier.

getOwnership

String getOwnership()

Get the ownership string of the component.

Returns:

The ownership string.

getType

String getType()

Get the component type.

Returns:

The component type name (e.g. 'BDI Agent').

getState

String getState()

Get the execution state of the component. E.g. active or suspended.

Returns:

The state.

getCreationTime

long getCreationTime()

Get the creation time.

Returns:

The creation time.

getCreator

IComponentIdentifier getCreator()

Get the creator of this component. (parent in case of child or external in case of top-level component).

getCause

Cause getCause()

Get the cause for creating the component.

Returns:

The cause.

getBreakpoints

String[] getBreakpoints()

Get the enabled breakpoints (if any).

Returns:

The enabled breakpoints.

getMaster

Boolean getMaster()

Is the component a master. When a master component is killed the parent component will be killed two.

Returns:

True, if master component.

getDaemon

Boolean getDaemon()

Is the component a daemon. When platform is in autoshutdown mode and the last non-daemon component is killed the platform will also be shutdowned.

Returns:

True, if daemon component.

getAutoShutdown

Boolean getAutoShutdown()

Get the auto shutdown flag.

Returns:

The flag.

getMonitoring

IMonitoringService.PublishEventLevel getMonitoring()

Get the monitoring flag.

Returns:

The monitoring flag.

getSynchronous

Boolean getSynchronous()

Get the synchronous flag.

Returns:

The synchronous flag.

getLocalType

String getLocalType()

Get the local type name of a component (defined in the parent).

Returns:

The local type.