Skip navigation links

oracle.soa.management.facade
Interface ComponentInstance

public interface ComponentInstance

SCA component instance facade

Field Summary

static int	STATE_COMPLETED_SUCCESSFULLY
static int	STATE_FAULTED
static int	STATE_RECOVERY_REQUIRED
static int	STATE_RUNNING
static int	STATE_STALE
static int	STATE_SUSPENDED
static int	STATE_TERMINATED_BY_USER
static int[]	STATES_INFLIGHT

Method Summary

java.lang.Object	getAuditTrail() Return audit trail.
java.lang.String	getComponentName() Returns the name of the component.
CompositeDN	getCompositeDN() Returns the distinguished name of the composite.
java.lang.String	getCompositeInstanceId() Return the id of the composite instance.
java.lang.String	getConversationId() Returns the conversationId of this instance.
java.util.Date	getCreationDate() Returns the creation date of this instance.
java.lang.String	getCreator() Returns the creator date of this instance.
java.lang.String	getECID() Returns the ecid.
java.util.List<Fault>	getFaults() Return the list of faults that have occurred during the execution of this component instance.
java.lang.String	getId() Returns the instance id of the instance.
java.util.Date	getModifyDate() Returns the date this instance was last modified on.
int	getNormalizedState() Returns the normalized state of this instance.
java.lang.String	getNormalizedStateAsString() Returns the normalized state as meaningful string.
int	getNumberOfFaults() Return the number of faults with this component instance.
java.lang.String	getParentId() Returns the parentId of this instance.
java.lang.String	getParentReferenceId()
ServiceEngine	getServiceEngine()
int	getState() Returns the current state of this instance.
java.lang.String	getStatus() Retrieves the current status of this instance.
boolean	hasAuditTrail() Returns true if the audit trail is saved a available for this instance.
boolean	hasAuditTrailPayloads() Returns true if the payloads are saved with the audit trail of this instance.
boolean	hasCompositeInstance() Returns true if the composite instance is saved in the db.
boolean	isTestCase() Returns true if the instance was created by a test run.
void	setNumberOfFaults(int faultCount) Returns the number of faults that happened during the execution of this instance.
void	setParentReferenceId(java.lang.String parentReferenceId)

Field Detail

STATE_RUNNING

static final int STATE_RUNNING

See Also:

Constant Field Values

STATE_RECOVERY_REQUIRED

static final int STATE_RECOVERY_REQUIRED

See Also:

Constant Field Values

STATE_COMPLETED_SUCCESSFULLY

static final int STATE_COMPLETED_SUCCESSFULLY

See Also:

Constant Field Values

STATE_FAULTED

static final int STATE_FAULTED

See Also:

Constant Field Values

STATE_TERMINATED_BY_USER

static final int STATE_TERMINATED_BY_USER

See Also:

Constant Field Values

STATE_SUSPENDED

static final int STATE_SUSPENDED

See Also:

Constant Field Values

STATE_STALE

static final int STATE_STALE

See Also:

Constant Field Values

STATES_INFLIGHT

static final int[] STATES_INFLIGHT

Method Detail

isTestCase

boolean isTestCase()

Returns true if the instance was created by a test run.

getId

java.lang.String getId()

Returns the instance id of the instance.

getComponentName

java.lang.String getComponentName()

Returns the name of the component.

getCompositeDN

CompositeDN getCompositeDN()

Returns the distinguished name of the composite.

getCreationDate

java.util.Date getCreationDate()

Returns the creation date of this instance.

getCreator

java.lang.String getCreator()

Returns the creator date of this instance.

getModifyDate

java.util.Date getModifyDate()

Returns the date this instance was last modified on.

getState

int getState()

Returns the current state of this instance.

getNormalizedState

int getNormalizedState()

Returns the normalized state of this instance.

getNormalizedStateAsString

java.lang.String getNormalizedStateAsString()

Returns the normalized state as meaningful string.

getStatus

java.lang.String getStatus()

Retrieves the current status of this instance. The status for the instance can be set via the setStatus() method from a BPELX java exec tag. <p/> The semantics attached to the status value are the sole domain and responsibility of the developer.

getConversationId

java.lang.String getConversationId()

Returns the conversationId of this instance. When an instance is created the user may pass the process domain a user-specified key; this key has no system-specific meaning and is only available as a means for linking a Collaxa process instance with an external system. <p/> The semantics attached to the status value are the sole domain and responsibility of the user.

getParentId

java.lang.String getParentId()

Returns the parentId of this instance. When an instance is calling other instance, a system specified id is passed. This id is identified by the instance being called as the parentId. This id can be used to locate the caller of an instance. <p/> <p/> The semantics attached to the status value are the sole domain and responsibility of the user.

getAuditTrail

java.lang.Object getAuditTrail()

Return audit trail.

getFaults

java.util.List<Fault> getFaults()
                                throws java.lang.Exception

Return the list of faults that have occurred during the execution of this component instance.

Throws:

java.lang.Exception

getNumberOfFaults

int getNumberOfFaults()
                      throws java.lang.Exception

Return the number of faults with this component instance.

Throws:

java.lang.Exception

getECID

java.lang.String getECID()

Returns the ecid.

getCompositeInstanceId

java.lang.String getCompositeInstanceId()

Return the id of the composite instance.

setNumberOfFaults

void setNumberOfFaults(int faultCount)

Returns the number of faults that happened during the execution of this instance.

Parameters:

faultCount -

hasCompositeInstance

boolean hasCompositeInstance()

Returns true if the composite instance is saved in the db.

hasAuditTrail

boolean hasAuditTrail()

Returns true if the audit trail is saved a available for this instance.

hasAuditTrailPayloads

boolean hasAuditTrailPayloads()

Returns true if the payloads are saved with the audit trail of this instance.

getServiceEngine

ServiceEngine getServiceEngine()

setParentReferenceId

void setParentReferenceId(java.lang.String parentReferenceId)

getParentReferenceId

java.lang.String getParentReferenceId()

Skip navigation links