org.opencrx.kernel.home1.jdo2
Class WfProcessInstance

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.opencrx.kernel.home1.jdo2.WfProcessInstance

All Implemented Interfaces:

Serializable, PropertySet, SecureObject, WfProcessInstance, BasicObject, ContextCapable, ExtentCapable, ViewCapable

public class WfProcessInstance
extends org.w3c.jdo2.AbstractObject
implements WfProcessInstance

Class WfProcessInstance

See Also:

Serialized Form

Nested Class Summary

static class	WfProcessInstance.Identity The object's application identity
static class	WfProcessInstance.Slice Slice object hold the WfProcessInstance's multivalued attributes

Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject

org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>

Field Summary

static List<String>	BASE_CLASS Define this class as base class
static List<String>	CLASS Define the model class org::opencrx::kernel::home1::WfProcessInstance

Constructor Summary

WfProcessInstance()

Method Summary

ModifySecureObjectResult	addOwningGroup(ModifyOwningGroupParams in)
void	addToUserHome(UserHome userHome) Sets a new value for the reference userHome.
void	addToUserHome(UserHome userHome, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:home1:UserHomeContainsWfProcessInstance.
CheckPermissionsResult	checkPermissions(CheckPermissionsParams in)
ViewCapable	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
short	getAccessLevelBrowse() Retrieves the value for the attribute accessLevelBrowse.
short	getAccessLevelDelete() Retrieves the value for the attribute accessLevelDelete.
short	getAccessLevelUpdate() Retrieves the value for the attribute accessLevelUpdate.
<T extends WfActionLogEntry> WfProcessInstanceHasActionLogEntry.ActionLog<T>	getActionLog() Retrieves a set containing all the elements for the reference actionLog.
<T extends Context> Map<String,T>	getContext() Retrieves the Collection of objects referenced by context.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
Set<String>	getCreatedBy() Retrieves a set containing all the elements for the attribute createdBy.
String	getIdentity() Retrieves the value for the attribute identity.
Date	getLastActivityOn() Retrieves the possibly null value for the optional attribute lastActivityOn.
Date	getModifiedAt() Retrieves the value for the attribute modifiedAt.
Set<String>	getModifiedBy() Retrieves a set containing all the elements for the attribute modifiedBy.
List<String>	getOwner() Retrieves a list containing all the elements for the attribute owner.
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
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> PropertySetContainsProperty.Property<T>	getProperty() Retrieves a set containing all the elements for the reference property.
Date	getStartedOn() Retrieves the possibly null value for the optional attribute startedOn.
Integer	getStepCounter() Retrieves the possibly null value for the optional attribute stepCounter.
String	getTargetObject() Retrieves the possibly null value for the optional attribute targetObject.
<T extends View> ObjectHasView.View<T>	getView() Retrieves a set containing all the elements for the reference view.
Boolean	isFailed() Retrieves the possibly null value for the optional attribute failed.
static WfProcessInstance.Identity	newIdentity(UserHome.Identity userHome, QualifierType idType, String id)
protected org.w3c.jdo2.AbstractObject.Slice	newSlice(int index)
protected List<String>	openmdxjdoGetClass() Retrieve the model class
protected String	openmdxjdoGetObjectId() Retrieve the object's JDO identity key
protected int	openmdxjdoGetSize(int field)
protected <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E>	openmdxjdoGetSlices()
protected void	openmdxjdoSetSize(int field, int size)
static WfProcessInstance.Identity	openmdxjdoToIdentity(ObjectId objectId)
ModifySecureObjectResult	removeAllOwningGroup(RemoveAllOwningGroupParams in)
ModifySecureObjectResult	removeOwningGroup(ModifyOwningGroupParams in)
ModifySecureObjectResult	setAccessLevel(SetAccessLevelParams in)
void	setAccessLevelBrowse(short accessLevelBrowse) Sets a new value for the attribute accessLevelBrowse.
void	setAccessLevelDelete(short accessLevelDelete) Sets a new value for the attribute accessLevelDelete.
void	setAccessLevelUpdate(short accessLevelUpdate) Sets a new value for the attribute accessLevelUpdate.
void	setFailed(Boolean failed) Sets a new value for the attribute failed.
void	setLastActivityOn(Date lastActivityOn) Sets a new value for the attribute lastActivityOn.
ModifySecureObjectResult	setOwningUser(SetOwningUserParams in)
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	setStartedOn(Date startedOn) Sets a new value for the attribute startedOn.
void	setStepCounter(Integer stepCounter) Sets a new value for the attribute stepCounter.
void	setTargetObject(String targetObject) Sets a new value for the attribute targetObject.

Methods inherited from class org.w3c.jdo2.AbstractObject

openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewMap, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement

Methods inherited from class org.oasisopen.jdo2.Identifiable

jdoClass, modelClasses, openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS

public static final List<String> CLASS

Define the model class org::opencrx::kernel::home1::WfProcessInstance

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

WfProcessInstance.CLASS

Constructor Detail

WfProcessInstance

public WfProcessInstance()

Method Detail

openmdxjdoGetObjectId

protected String openmdxjdoGetObjectId()

Retrieve the object's JDO identity key

Specified by:

openmdxjdoGetObjectId in class org.oasisopen.jdo2.Identifiable

Returns:

the value of the object's JDO identity key

openmdxjdoGetSlices

protected final <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E> openmdxjdoGetSlices()

Overrides:

openmdxjdoGetSlices in class org.w3c.jdo2.AbstractObject

getTargetObject

public final String getTargetObject()

Retrieves the possibly null value for the optional attribute targetObject.

Specified by:

getTargetObject in interface WfProcessInstance

Returns:

The possibly null value for attribute targetObject.

setTargetObject

public void setTargetObject(String targetObject)

Sets a new value for the attribute targetObject.

Specified by:

setTargetObject in interface WfProcessInstance

Parameters:

targetObject - The possibly null new value for attribute targetObject.

getAccessLevelDelete

public short getAccessLevelDelete()

Retrieves the value for the attribute accessLevelDelete.

Specified by:

getAccessLevelDelete in interface SecureObject

Returns:

The non-null value for attribute accessLevelDelete.

setAccessLevelDelete

public void setAccessLevelDelete(short accessLevelDelete)

Sets a new value for the attribute accessLevelDelete.

Specified by:

setAccessLevelDelete in interface SecureObject

Parameters:

accessLevelDelete - The non-null new value for attribute accessLevelDelete.

getModifiedAt

public Date getModifiedAt()

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface BasicObject

Returns:

The non-null value for attribute modifiedAt.

getActionLog

public <T extends WfActionLogEntry> WfProcessInstanceHasActionLogEntry.ActionLog<T> getActionLog()

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

Specified by:

getActionLog in interface WfProcessInstance

Returns:

A set containing all the elements for this reference.

getModifiedBy

public final Set<String> getModifiedBy()

Retrieves a set containing all the elements for the attribute modifiedBy.

Specified by:

getModifiedBy in interface BasicObject

Returns:

A set containing all elements for this attribute.

isFailed

public final Boolean isFailed()

Retrieves the possibly null value for the optional attribute failed.

Specified by:

isFailed in interface WfProcessInstance

Returns:

The possibly null value for attribute failed.

setFailed

public void setFailed(Boolean failed)

Sets a new value for the attribute failed.

Specified by:

setFailed in interface WfProcessInstance

Parameters:

failed - The possibly null new value for attribute failed.

getAccessLevelBrowse

public short getAccessLevelBrowse()

Retrieves the value for the attribute accessLevelBrowse.

Specified by:

getAccessLevelBrowse in interface SecureObject

Returns:

The non-null value for attribute accessLevelBrowse.

setAccessLevelBrowse

public void setAccessLevelBrowse(short accessLevelBrowse)

Sets a new value for the attribute accessLevelBrowse.

Specified by:

setAccessLevelBrowse in interface SecureObject

Parameters:

accessLevelBrowse - The non-null new value for attribute accessLevelBrowse.

getLastActivityOn

public final Date getLastActivityOn()

Retrieves the possibly null value for the optional attribute lastActivityOn.

Specified by:

getLastActivityOn in interface WfProcessInstance

Returns:

The possibly null value for attribute lastActivityOn.

setLastActivityOn

public void setLastActivityOn(Date lastActivityOn)

Sets a new value for the attribute lastActivityOn.

Specified by:

setLastActivityOn in interface WfProcessInstance

Parameters:

lastActivityOn - The possibly null new value for attribute lastActivityOn.

getIdentity

public String getIdentity()

Retrieves the value for the attribute identity.

Specified by:

getIdentity in interface ExtentCapable

Returns:

The non-null value for attribute identity.

getStartedOn

public final Date getStartedOn()

Retrieves the possibly null value for the optional attribute startedOn.

Specified by:

getStartedOn in interface WfProcessInstance

Returns:

The possibly null value for attribute startedOn.

setStartedOn

public void setStartedOn(Date startedOn)

Sets a new value for the attribute startedOn.

Specified by:

setStartedOn in interface WfProcessInstance

Parameters:

startedOn - The possibly null new value for attribute startedOn.

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams in)

Specified by:

removeAllOwningGroup in interface SecureObject

getCreatedAt

public Date getCreatedAt()

Retrieves the value for the attribute createdAt.

Specified by:

getCreatedAt in interface BasicObject

Returns:

The non-null value for attribute createdAt.

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams in)

Specified by:

setOwningUser in interface SecureObject

getOwningGroup

public <T extends PrincipalGroup> List<T> getOwningGroup()

Retrieves the Collection of objects referenced by owningGroup.

Specified by:

getOwningGroup in interface SecureObject

Returns:

The Collection of referenced objects.

getStepCounter

public final Integer getStepCounter()

Retrieves the possibly null value for the optional attribute stepCounter.

Specified by:

getStepCounter in interface WfProcessInstance

Returns:

The possibly null value for attribute stepCounter.

setStepCounter

public void setStepCounter(Integer stepCounter)

Sets a new value for the attribute stepCounter.

Specified by:

setStepCounter in interface WfProcessInstance

Parameters:

stepCounter - The possibly null new value for attribute stepCounter.

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams in)

Specified by:

addOwningGroup in interface SecureObject

getParent

public WfProcessInstance getParent()

Retrieves the value for the reference parent.

Specified by:

getParent in interface WfProcessInstance

Returns:

The – possibly null – value for this reference.

setParent

public 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.

checkPermissions

public CheckPermissionsResult checkPermissions(CheckPermissionsParams in)

Specified by:

checkPermissions in interface SecureObject

getProperty

public <T extends Property> PropertySetContainsProperty.Property<T> getProperty()

Retrieves a set containing all the elements for the reference property.

Specified by:

getProperty in interface PropertySet

Returns:

A set containing all the elements for this reference.

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)

Specified by:

removeOwningGroup in interface SecureObject

getProcess

public WfProcess getProcess()

Retrieves the value for the reference process.

Specified by:

getProcess in interface WfProcessInstance

Returns:

The non-null value for this reference.

setProcess

public 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.

getAccessLevelUpdate

public short getAccessLevelUpdate()

Retrieves the value for the attribute accessLevelUpdate.

Specified by:

getAccessLevelUpdate in interface SecureObject

Returns:

The non-null value for attribute accessLevelUpdate.

setAccessLevelUpdate

public void setAccessLevelUpdate(short accessLevelUpdate)

Sets a new value for the attribute accessLevelUpdate.

Specified by:

setAccessLevelUpdate in interface SecureObject

Parameters:

accessLevelUpdate - The non-null new value for attribute accessLevelUpdate.

getCreatedBy

public final Set<String> getCreatedBy()

Retrieves a set containing all the elements for the attribute createdBy.

Specified by:

getCreatedBy in interface BasicObject

Returns:

A set containing all elements for this attribute.

getAccessGrantedByParent

public ViewCapable getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams in)

Specified by:

setAccessLevel in interface SecureObject

getOwner

public final List<String> getOwner()

Retrieves a list containing all the elements for the attribute owner.

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

getContext

public <T extends Context> Map<String,T> getContext()

Retrieves the Collection of objects referenced by context.

Specified by:

getContext in interface ContextCapable

Returns:

The Collection of referenced objects.

getView

public <T extends View> ObjectHasView.View<T> getView()

Retrieves a set containing all the elements for the reference view.

Specified by:

getView in interface ViewCapable

Returns:

A set containing all the elements for this reference.

getOwningUser

public User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

public 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.

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class org.w3c.jdo2.AbstractObject

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class org.w3c.jdo2.AbstractObject

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()

Retrieve the model class

Returns:

the model class

See Also:

WfProcessInstance.CLASS

addToUserHome

public void addToUserHome(UserHome userHome)

Sets a new value for the reference userHome.

Parameters:

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

addToUserHome

public void addToUserHome(UserHome userHome,
                          boolean idIsPersistent,
                          String id)

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

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.

newIdentity

public static WfProcessInstance.Identity newIdentity(UserHome.Identity userHome,
                                                     QualifierType idType,
                                                     String id)

openmdxjdoToIdentity

public static WfProcessInstance.Identity openmdxjdoToIdentity(ObjectId objectId)