org.opencrx.kernel.home1.jmi1
Interface WfProcessInstance

All Superinterfaces:
BasicObject, ContextCapable, Creatable, ExtentCapable, Modifiable, PropertySet, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, WfProcessInstance

public interface WfProcessInstance
extends WfProcessInstance, PropertySet, SecureObject, BasicObject

Class WfProcessInstance

isFrozenisFrozenisFrozen


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.opencrx.kernel.home1.cci2.WfProcessInstance
WfProcessInstance.Identity
 
Method Summary
 void addActionLog(boolean idIsPersistent, String id, WfActionLogEntry actionLog)
          Adds the specified element to the set of the values for the reference actionLog.
 void addActionLog(String id, WfActionLogEntry actionLog)
          Adds the specified element to the set of the values for the reference actionLog using a reassignable qualifier.
 void addActionLog(WfActionLogEntry actionLog)
          Adds the specified element to the set of the values for the reference actionLog using an implementation-specific, reassignable qualifier.
 void addChildProcessInstance(boolean idIsPersistent, String id, WfProcessInstance childProcessInstance)
          Adds the specified element to the set of the values for the reference childProcessInstance.
 void addChildProcessInstance(String id, WfProcessInstance childProcessInstance)
          Adds the specified element to the set of the values for the reference childProcessInstance using a reassignable qualifier.
 void addChildProcessInstance(WfProcessInstance childProcessInstance)
          Adds the specified element to the set of the values for the reference childProcessInstance using an implementation-specific, reassignable qualifier.
 WfActionLogEntry getActionLog(boolean idIsPersistent, String id)
          Retrieves the value for the reference actionLog for the specified qualifier attribute value.
 WfActionLogEntry getActionLog(String id)
          Retrieves the value for the reference actionLog for the specified qualifier attribute value.
<T extends WfActionLogEntry>
List<T>
getActionLog(WfActionLogEntryQuery query)
          Retrieves the value for the reference actionLog for the specified query.
 WfProcessInstance getChildProcessInstance(boolean idIsPersistent, String id)
          Retrieves the value for the reference childProcessInstance for the specified qualifier attribute value.
 WfProcessInstance getChildProcessInstance(String id)
          Retrieves the value for the reference childProcessInstance for the specified qualifier attribute value.
<T extends WfProcessInstance>
List<T>
getChildProcessInstance(WfProcessInstanceQuery query)
          Retrieves the value for the reference childProcessInstance for the specified query.
 WfProcessInstance getParent()
          Retrieves the value for the reference parent.
 WfProcess getProcess()
          Retrieves the value for the reference process.
 void setParent(WfProcessInstance parent)
          Sets a new value for the reference parent.
 void setProcess(WfProcess process)
          Sets a new value for the reference process.
 
Methods inherited from interface org.opencrx.kernel.home1.cci2.WfProcessInstance
getActionLog, getChildProcessInstance, getLastActivityOn, getName, getStartedOn, getStepCounter, getTargetObject, isFailed, setFailed, setLastActivityOn, setName, setStartedOn, setStepCounter, setTargetObject
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.PropertySet
addProperty, addProperty, addProperty, getProperty, getProperty, getProperty
 
Methods inherited from interface org.opencrx.kernel.base.cci2.PropertySet
getProperty
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.SecureObject
addOwningGroup, checkPermissions, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwner, setOwningUser, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject
addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser
 
Methods inherited from interface org.openmdx.base.jmi1.Creatable
getCreatedBy
 
Methods inherited from interface org.openmdx.base.cci2.Creatable
getCreatedAt
 
Methods inherited from interface org.openmdx.base.cci2.ExtentCapable
getIdentity
 
Methods inherited from interface org.openmdx.base.jmi1.Modifiable
getModifiedBy
 
Methods inherited from interface org.openmdx.base.cci2.Modifiable
getModifiedAt
 
Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0
refDefaultFetchGroup, refDelegate, refGetPath, refGetValue, refInitialize, refInitialize, refSetValue
 
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

<T extends WfActionLogEntry> List<T> getActionLog(WfActionLogEntryQuery query)
Retrieves the value for the reference actionLog for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

getActionLog

WfActionLogEntry getActionLog(boolean idIsPersistent,
                              String id)
Retrieves the value for the reference actionLog for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getActionLog

WfActionLogEntry getActionLog(String id)
Retrieves the value for the reference actionLog for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getActionLog(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addActionLog

void addActionLog(boolean idIsPersistent,
                  String id,
                  WfActionLogEntry actionLog)
Adds the specified element to the set of the values for the reference actionLog.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
actionLog - The element to be appended.

addActionLog

void addActionLog(String id,
                  WfActionLogEntry actionLog)
Adds the specified element to the set of the values for the reference actionLog using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addActionLog

void addActionLog(WfActionLogEntry actionLog)
Adds the specified element to the set of the values for the reference actionLog using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
actionLog - The element to be appended.

getChildProcessInstance

<T extends WfProcessInstance> List<T> getChildProcessInstance(WfProcessInstanceQuery query)
Retrieves the value for the reference childProcessInstance for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

getChildProcessInstance

WfProcessInstance getChildProcessInstance(boolean idIsPersistent,
                                          String id)
Retrieves the value for the reference childProcessInstance for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

getChildProcessInstance

WfProcessInstance getChildProcessInstance(String id)
Retrieves the value for the reference childProcessInstance for the specified qualifier attribute value.

This method is equivalent to the preferred invocation getChildProcessInstance(false,id).

Parameters:
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addChildProcessInstance

void addChildProcessInstance(boolean idIsPersistent,
                             String id,
                             WfProcessInstance childProcessInstance)
Adds the specified element to the set of the values for the reference childProcessInstance.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
childProcessInstance - The element to be appended.

addChildProcessInstance

void addChildProcessInstance(String id,
                             WfProcessInstance childProcessInstance)
Adds the specified element to the set of the values for the reference childProcessInstance using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

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

addChildProcessInstance

void addChildProcessInstance(WfProcessInstance childProcessInstance)
Adds the specified element to the set of the values for the reference childProcessInstance using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:
childProcessInstance - The element to be appended.

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 new – possibly null – value for this reference.

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 new non-null value for this reference.


This software is published under the BSD license. Copyright © 2003-2013, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.