wt.workflow.engine
Class WfProcessReference

java.lang.Object
  extended bywt.fc.ObjectReference
      extended bywt.fc.CachedObjectReference
          extended bywt.workflow.engine.WfContainerReference
              extended bywt.workflow.engine.WfProcessReference
All Implemented Interfaces:
Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable, WTReference

public class WfProcessReference
extends WfContainerReference
implements Externalizable

WfProcessReference represents references to a given workflow processes.

Use the newWfProcessReference static factory method(s), not the WfProcessReference constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: false

Extendable: false

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class wt.fc.CachedObjectReference
 
Field Summary
private static String CLASSNAME
           
static long EXTERNALIZATION_VERSION_UID
           
static String OBJECT
          Label for the attribute.
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Fields inherited from class wt.workflow.engine.WfContainerReference
NAME
 
Fields inherited from class wt.fc.CachedObjectReference
INFLATED
 
Fields inherited from class wt.fc.ObjectReference
KEY, object, OBJECT_ID
 
Constructor Summary
WfProcessReference()
           
 
Method Summary
 String getConceptualClassname()
          Deprecated.  
protected  void initialize(ObjectIdentifier process_id)
          Supports initialization, following construction of an instance.
protected  void initialize(WfProcess process)
          Supports initialization, following construction of an instance.
protected  void initialize(WfProcessReference process_ref)
          Supports initialization, following construction of an instance.
static WfProcessReference newWfProcessReference()
          No-arg process reference constructor.
static WfProcessReference newWfProcessReference(ObjectIdentifier process_id)
          Constructs a workflow process reference given the object identifier of the process.
static WfProcessReference newWfProcessReference(WfProcess process)
          Constructs a WfProcessReference object given the target process.
static WfProcessReference newWfProcessReference(WfProcessReference process_ref)
          Constructs a process reference given another process reference.
 void readExternal(ObjectInput input)
          Reads the non-transient fields of this class from an external source.
 void readExternal(PersistentRetrieveIfc input)
          Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private  boolean readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source, which is not the current version.
protected  boolean readVersion(WfProcessReference thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 String toString()
          Returns string representation of the object.
 void writeExternal(ObjectOutput output)
          Writes the non-transient fields of this class to an external source.
 void writeExternal(PersistentStoreIfc output)
          Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.
 
Methods inherited from class wt.workflow.engine.WfContainerReference
getIdentity, getName, inflate, inflate, initialize, initialize, newWfContainerReference, newWfContainerReference, newWfContainerReference, newWfContainerReference, readVersion
 
Methods inherited from class wt.fc.CachedObjectReference
deflate, getObject, getReadOnlyObject, inflate, isInflated, isObjectInflated, readVersion, refresh, reset, setInflated, setObjectNull
 
Methods inherited from class wt.fc.ObjectReference
equals, getClassInfo, getKey, getObjectId, getReferencedClass, getReferencedClass, hashCode, hasPersistence, initialize, initialize, initialize, newObjectReference, newObjectReference, newObjectReference, newObjectReference, readVersion, references, setKey, setObject, setObjectId
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

OBJECT

public static final String OBJECT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID
See Also:
Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID
See Also:
Constant Field Values
Constructor Detail

WfProcessReference

public WfProcessReference()
Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException
Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class WfContainerReference
Parameters:
output -
Throws:
IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class WfContainerReference
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(WfProcessReference thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException
Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:
thisObject -
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException
Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:
input -
readSerialVersionUID -
passThrough -
superDone -
Returns:
boolean
Throws:
IOException
ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException
Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:
writeExternal in interface ObjectMappable
Overrides:
writeExternal in class WfContainerReference
Parameters:
output -
Throws:
SQLException
DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException
Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:
readExternal in interface ObjectMappable
Overrides:
readExternal in class WfContainerReference
Parameters:
input -
Throws:
SQLException
DatastoreException

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Overrides:
getConceptualClassname in class WfContainerReference
Returns:
String

newWfProcessReference

public static WfProcessReference newWfProcessReference(WfProcess process)
                                                throws WTException
Constructs a WfProcessReference object given the target process.

Supported API: false

Parameters:
process -
Returns:
WfProcessReference
Throws:
WTException

initialize

protected void initialize(WfProcess process)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:
process -
Throws:
WTException

newWfProcessReference

public static WfProcessReference newWfProcessReference()
                                                throws WTException
No-arg process reference constructor.

Supported API: false

Returns:
WfProcessReference
Throws:
WTException

newWfProcessReference

public static WfProcessReference newWfProcessReference(WfProcessReference process_ref)
                                                throws WTException
Constructs a process reference given another process reference.

Supported API: false

Parameters:
process_ref -
Returns:
WfProcessReference
Throws:
WTException

initialize

protected void initialize(WfProcessReference process_ref)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:
process_ref -
Throws:
WTException

newWfProcessReference

public static WfProcessReference newWfProcessReference(ObjectIdentifier process_id)
                                                throws WTException
Constructs a workflow process reference given the object identifier of the process.

Supported API: false

Parameters:
process_id -
Returns:
WfProcessReference
Throws:
WTException

initialize

protected void initialize(ObjectIdentifier process_id)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Overrides:
initialize in class WfContainerReference
Parameters:
process_id -
Throws:
WTException

toString

public String toString()
Returns string representation of the object. Used mostly for debugging purposes: not appropriate for GUI use.

Supported API: false

Overrides:
toString in class WfContainerReference
Returns:
String