wt.workflow.definer
Class WfProcessTemplateReference

java.lang.Object
  extended bywt.fc.ObjectReference
      extended bywt.fc.CachedObjectReference
          extended bywt.workflow.definer.WfContainerTemplateReference
              extended bywt.workflow.definer.WfProcessTemplateReference
All Implemented Interfaces:
Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable, WTReference

public class WfProcessTemplateReference
extends WfContainerTemplateReference
implements Externalizable

Reference to a process template object.

Use the newWfProcessTemplateReference static factory method(s), not the WfProcessTemplateReference 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
           
private  boolean enabled
           
static String ENABLED
          Label for the attribute.
static long EXTERNALIZATION_VERSION_UID
           
private  WfContainerTemplate object
           
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.definer.WfContainerTemplateReference
NAME
 
Fields inherited from class wt.fc.CachedObjectReference
INFLATED
 
Fields inherited from class wt.fc.ObjectReference
KEY, OBJECT_ID
 
Constructor Summary
WfProcessTemplateReference()
           
 
Method Summary
 String getConceptualClassname()
          Deprecated.  
 String getIdentity()
          

Supported API: false
protected  void initialize(ObjectIdentifier template_id)
          Supports initialization, following construction of an instance.
protected  void initialize(String template_name)
          Supports initialization, following construction of an instance.
protected  void initialize(WfProcessTemplate template)
          Supports initialization, following construction of an instance.
protected  void initialize(WfProcessTemplateReference template_ref)
          Supports initialization, following construction of an instance.
 boolean isEnabled()
          Gets the value of the attribute: ENABLED.
static WfProcessTemplateReference newWfProcessTemplateReference()
          No-arg process template reference constructor.
static WfProcessTemplateReference newWfProcessTemplateReference(ObjectIdentifier template_id)
          Constructs a process template reference given the object identifier of a process template.
static WfProcessTemplateReference newWfProcessTemplateReference(String template_name)
          Constructs a process template given its name.
static WfProcessTemplateReference newWfProcessTemplateReference(WfProcessTemplate template)
          Constructs a process template reference given a process template.
static WfProcessTemplateReference newWfProcessTemplateReference(WfProcessTemplateReference template_ref)
          Constructs a process template reference given a reference to a process template.
 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(WfProcessTemplateReference thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 String toString()
          Returns a 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.definer.WfContainerTemplateReference
getName, inflate, inflate, initialize, initialize, newWfContainerTemplateReference, newWfContainerTemplateReference, newWfContainerTemplateReference, newWfContainerTemplateReference, 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

ENABLED

public static final String ENABLED
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

enabled

private boolean enabled

OBJECT

public static final String OBJECT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

object

private WfContainerTemplate object

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

WfProcessTemplateReference

public WfProcessTemplateReference()
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 WfContainerTemplateReference
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 WfContainerTemplateReference
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(WfProcessTemplateReference 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 WfContainerTemplateReference
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 WfContainerTemplateReference
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 WfContainerTemplateReference
Returns:
String

isEnabled

public boolean isEnabled()
Gets the value of the attribute: ENABLED.

Supported API: false

Returns:
boolean

newWfProcessTemplateReference

public static WfProcessTemplateReference newWfProcessTemplateReference(WfProcessTemplate template)
                                                                throws WTException
Constructs a process template reference given a process template.

Supported API: false

Parameters:
template -
Returns:
WfProcessTemplateReference
Throws:
WTException

initialize

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

Supported API: false

Parameters:
template -
Throws:
WTException

newWfProcessTemplateReference

public static WfProcessTemplateReference newWfProcessTemplateReference()
                                                                throws WTException
No-arg process template reference constructor.

Supported API: false

Returns:
WfProcessTemplateReference
Throws:
WTException

newWfProcessTemplateReference

public static WfProcessTemplateReference newWfProcessTemplateReference(WfProcessTemplateReference template_ref)
                                                                throws WTException
Constructs a process template reference given a reference to a process template.

Supported API: false

Parameters:
template_ref -
Returns:
WfProcessTemplateReference
Throws:
WTException

initialize

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

Supported API: false

Parameters:
template_ref -
Throws:
WTException

newWfProcessTemplateReference

public static WfProcessTemplateReference newWfProcessTemplateReference(String template_name)
                                                                throws WTException
Constructs a process template given its name. Throws an exception if template doesn't exist.

Supported API: false

Parameters:
template_name -
Returns:
WfProcessTemplateReference
Throws:
WTException

initialize

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

Supported API: false

Parameters:
template_name -
Throws:
WTException

newWfProcessTemplateReference

public static WfProcessTemplateReference newWfProcessTemplateReference(ObjectIdentifier template_id)
                                                                throws WTException
Constructs a process template reference given the object identifier of a process template.

Supported API: false

Parameters:
template_id -
Returns:
WfProcessTemplateReference
Throws:
WTException

initialize

protected void initialize(ObjectIdentifier template_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 WfContainerTemplateReference
Parameters:
template_id -
Throws:
WTException

getIdentity

public String getIdentity()


Supported API: false

Overrides:
getIdentity in class WfContainerTemplateReference
Returns:
String

toString

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

Supported API: false

Overrides:
toString in class WfContainerTemplateReference
Returns:
String