org.opencrx.kernel.home1.jmi1
Interface WfProcessInstance

All Superinterfaces:

org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, PropertySet, RefBaseObject, RefFeatured, RefObject, SecureObject, org.openmdx.compatibility.view1.cci2.ViewCapable, WfProcessInstance

public interface WfProcessInstance
extends WfProcessInstance, PropertySet, SecureObject, org.openmdx.base.jmi1.BasicObject

Class WfProcessInstance

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencrx.kernel.home1.cci2.WfProcessInstance

WfProcessInstance.Identity

Method Summary

void	addActionLog(String id, WfActionLogEntry newValue)
void	addActionLog(WfActionLogEntry newValue)
void	addOwningGroup(int index, PrincipalGroup newValue)
void	addOwningGroup(PrincipalGroup newValue)
void	addProperty(Property newValue)
void	addProperty(String id, Property newValue)
org.openmdx.base.cci2.BasicObject	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
<T extends WfActionLogEntry> List<T>	getActionLog(WfActionLogEntryQuery query) Retrieves the value for the reference actionLog for the specified query.
User	getOwningUser() Retrieves the value for the reference owningUser.
WfProcessInstance	getParent() Retrieves the value for the reference parent.
WfProcess	getProcess() Retrieves the value for the reference process.
<T extends Property> List<T>	getProperty(PropertyQuery query) Retrieves the value for the reference property for the specified query.
<T extends org.openmdx.compatibility.view1.cci2.View> List<T>	getView(org.openmdx.compatibility.view1.cci2.ViewQuery query) Retrieves the value for the reference view for the specified query.
void	removeActionLog(String id)
void	removeOwningGroup(int index)
void	removeOwningUser() Removes the value for the optional reference owningUser.
void	removeParent() Removes the value for the optional reference parent.
void	removeProperty(String id)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
void	setParent(WfProcessInstance parent) Sets a new value for the reference parent.
void	setProcess(WfProcess process) Sets a new value for the reference process.
void	setUserHome(UserHome userHome) Sets a new value for the reference userHome.
void	setUserHome(UserHome userHome, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:home1:UserHomeContainsWfProcessInstance.

Methods inherited from interface org.opencrx.kernel.home1.cci2.WfProcessInstance

getActionLog, getLastActivityOn, getStartedOn, getStepCounter, getTargetObject, isFailed, setFailed, setLastActivityOn, setStartedOn, setStepCounter, setTargetObject

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

getProperty

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

addOwningGroup, getOwner, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setOwningUser

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

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

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

getCreatedBy, getModifiedBy

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

getCreatedAt, getModifiedAt

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

getIdentity

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

getView

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

getProperty

<T extends Property> List<T> getProperty(PropertyQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

addProperty

void addProperty(String id,
                 Property newValue)

Parameters:

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

newValue - The element to be appended.

addProperty

void addProperty(Property newValue)

Parameters:

newValue - The element to be appended.

removeProperty

void removeProperty(String id)

getAccessGrantedByParent

org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

addOwningGroup

void addOwningGroup(int index,
                    PrincipalGroup newValue)

Parameters:

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

newValue - The element to be appended.

addOwningGroup

void addOwningGroup(PrincipalGroup newValue)

Parameters:

newValue - The element to be appended.

removeOwningGroup

void removeOwningGroup(int index)

getOwningUser

User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

void setOwningUser(User owningUser)

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

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

removeOwningUser

void removeOwningUser()

Removes the value for the optional reference owningUser.

getActionLog

<T extends WfActionLogEntry> List<T> getActionLog(WfActionLogEntryQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

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.

addActionLog

void addActionLog(WfActionLogEntry newValue)

Parameters:

newValue - The element to be appended.

removeActionLog

void removeActionLog(String id)

getParent

WfProcessInstance getParent()

Retrieves the value for the reference parent.

Specified by:

getParent in interface WfProcessInstance

Returns:

The – possibly null – value for this reference.

setParent

void setParent(WfProcessInstance parent)

Sets a new value for the reference parent.

Specified by:

setParent in interface WfProcessInstance

Parameters:

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

removeParent

void removeParent()

Removes the value for the optional reference parent.

getProcess

WfProcess getProcess()

Retrieves the value for the reference process.

Specified by:

getProcess in interface WfProcessInstance

Returns:

The non-null value for this reference.

setProcess

void setProcess(WfProcess process)

Sets a new value for the reference process.

Specified by:

setProcess in interface WfProcessInstance

Parameters:

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

getView

<T extends org.openmdx.compatibility.view1.cci2.View> List<T> getView(org.openmdx.compatibility.view1.cci2.ViewQuery query)

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

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

setUserHome

void setUserHome(UserHome userHome)

Sets a new value for the reference userHome.

Specified by:

setUserHome in interface WfProcessInstance

Parameters:

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

setUserHome

void setUserHome(UserHome userHome,
                 boolean idIsPersistent,
                 String id)

Set the object's composite association org:opencrx:kernel:home1:UserHomeContainsWfProcessInstance.

Specified by:

setUserHome in interface WfProcessInstance

Parameters:

userHome - The non-null new value for this object's composite owner.

idIsPersistent - Defines whether the id is persistent.

id - The non-null new value for this object's qualifier.