org.opencrx.kernel.home1.cci
Interface WfProcessInstance

All Superinterfaces:

BasicObject, ContextCapable, ExtentCapable, PropertySet, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, ViewCapable

All Known Implementing Classes:

WfProcessInstanceImpl

public interface WfProcessInstance
extends PropertySet, SecureObject, BasicObject

Method Summary

void	addActionLog(String id, WfActionLogEntry newValue)
void	addActionLog(WfActionLogEntry newValue)
Collection	getActionLog() Retrieves a collection containing all the elements for the reference actionLog.
WfActionLogEntry	getActionLog(String id) Retrieves the value for the reference actionLog for the specified qualifier attribute value.
List	getActionLog(WfActionLogEntryFilter filter) Retrieves the value for the reference actionLog for the specified filter.
List	getActionLog(WfActionLogEntryQuery query) Retrieves the value for the reference actionLog for the specified query.
Date	getLastActivityOn()
WfProcessInstance	getParent() Retrieves the value for the optional reference parent.
WfProcess	getProcess() Retrieves the value for the reference process.
Date	getStartedOn()
Integer	getStepCounter()
String	getTargetObject()
Boolean	isFailed()
void	removeActionLog(String id)
void	removeParent() Removes the value for the optional reference parent.
void	setFailed(Boolean newValue) Sets a new value for the attribute failed.
void	setLastActivityOn(Date newValue) Sets a new value for the attribute lastActivityOn.
void	setParent(WfProcessInstance newValue) Sets a new value for the reference parent.
void	setProcess(WfProcess newValue) Sets a new value for the reference process.
void	setStartedOn(Date newValue) Sets a new value for the attribute startedOn.
void	setStepCounter(Integer newValue) Sets a new value for the attribute stepCounter.
void	setTargetObject(String newValue) Sets a new value for the attribute targetObject.

Methods inherited from interface org.opencrx.kernel.base.cci.PropertySet

addProperty, addProperty, getProperty, getProperty, getProperty, getProperty, removeProperty

Methods inherited from interface org.opencrx.kernel.base.cci.SecureObject

addOwningGroup, addOwningGroup, addOwningGroup, addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwner, getOwningGroup, getOwningGroup, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningUser, setAccessLevel, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser, setOwningUser

Methods inherited from interface org.openmdx.base.cci.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

Methods inherited from interface org.openmdx.base.cci.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, getView

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Method Detail

getActionLog

WfActionLogEntry getActionLog(String id)

Retrieves the value for the reference actionLog for the specified qualifier attribute value.

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getActionLog

Collection getActionLog()

Retrieves a collection containing all the elements for the reference actionLog.

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getActionLog

List getActionLog(WfActionLogEntryFilter filter)

Retrieves the value for the reference actionLog for the specified filter.

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getActionLog

List getActionLog(WfActionLogEntryQuery query)

Retrieves the value for the reference actionLog for the specified query.

Parameters:

predicate - predicate which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addActionLog

void addActionLog(String id,
                  WfActionLogEntry newValue)

Parameters:

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addActionLog

void addActionLog(WfActionLogEntry newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeActionLog

void removeActionLog(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

isFailed

Boolean isFailed()

Returns:

The possibly null value for attribute failed.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setFailed

void setFailed(Boolean newValue)

Sets a new value for the attribute failed.

Parameters:

newValue - The possibly null new value for attribute failed.

Throws:

JmiException - If the value cannot be set for some reason.

getLastActivityOn

Date getLastActivityOn()

Returns:

The possibly null value for attribute lastActivityOn.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setLastActivityOn

void setLastActivityOn(Date newValue)

Sets a new value for the attribute lastActivityOn.

Parameters:

newValue - The possibly null new value for attribute lastActivityOn.

Throws:

JmiException - If the value cannot be set for some reason.

getParent

WfProcessInstance getParent()

Retrieves the value for the optional reference parent.

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setParent

void setParent(WfProcessInstance newValue)

Sets a new value for the reference parent.

Parameters:

newValue - The non-null new value for this reference.

Throws:

JmiException - If the value cannot be set for some reason.

removeParent

void removeParent()

Removes the value for the optional reference parent.

Throws:

JmiException - If the value cannot be removed for some reason.

getProcess

WfProcess getProcess()

Retrieves the value for the reference process.

Returns:

The non-null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setProcess

void setProcess(WfProcess newValue)

Sets a new value for the reference process.

Parameters:

newValue - The non-null new value for this reference.

Throws:

JmiException - If the value cannot be set for some reason.

getStartedOn

Date getStartedOn()

Returns:

The possibly null value for attribute startedOn.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setStartedOn

void setStartedOn(Date newValue)

Sets a new value for the attribute startedOn.

Parameters:

newValue - The possibly null new value for attribute startedOn.

Throws:

JmiException - If the value cannot be set for some reason.

getStepCounter

Integer getStepCounter()

Returns:

The possibly null value for attribute stepCounter.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setStepCounter

void setStepCounter(Integer newValue)

Sets a new value for the attribute stepCounter.

Parameters:

newValue - The possibly null new value for attribute stepCounter.

Throws:

JmiException - If the value cannot be set for some reason.

getTargetObject

String getTargetObject()

Returns:

The possibly null value for attribute targetObject.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setTargetObject

void setTargetObject(String newValue)

Sets a new value for the attribute targetObject.

Parameters:

newValue - The possibly null new value for attribute targetObject.

Throws:

JmiException - If the value cannot be set for some reason.