wt.lifecycle
Class LifeCycleTemplateReference

java.lang.Object
  wt.fc.ObjectReference
      wt.fc.CachedObjectReference
          wt.lifecycle.LifeCycleTemplateReference

All Implemented Interfaces:

Evolvable, Externalizable, NetFactor, ObjectMappable, Serializable, WTReference

public class LifeCycleTemplateReference

extends CachedObjectReference

implements Externalizable

LifeCycleTemplateReference is a specialization of CachedObjectReference to provide type safe references and access to the name and enabled attributes without instantiating the object.

Use the newLifeCycleTemplateReference static factory method(s), not the LifeCycleTemplateReference 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:

LifeCycleTemplate, CachedObjectReference, Serialized Form

Nested Class Summary

Nested classes inherited from class wt.fc.CachedObjectReference

Field Summary

private boolean	basic
static String	BASIC Label for the attribute; This attribute is used to specify if the lifecycle template is basic (no roles, ad hoc access, workflows or criteria) or advanced (may contain roles, ad hoc access, access, workfow and criteria).
private static String	CLASSNAME
private boolean	enabled
static String	ENABLED Label for the attribute; LifeCycle enabled attribute, inflated from the cache.
static long	EXTERNALIZATION_VERSION_UID
private String	identity
static String	IDENTITY Label for the attribute; LifeCycle Identity information, inflated from the cache.
private String	name
static String	NAME Label for the attribute; LifeCycle name inflated from the cache.
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.fc.CachedObjectReference

INFLATED

Fields inherited from class wt.fc.ObjectReference

KEY, object, OBJECT_ID

Constructor Summary

LifeCycleTemplateReference()

Method Summary

String	getConceptualClassname() Deprecated.
String	getIdentity() Gets the value of the attribute: IDENTITY.
String	getName() Gets the value of the attribute: NAME.
void	inflate(CachedObjectReference cor) Supported API: false
void	inflate(Persistable obj) Supported API: false
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(LifeCycleTemplate lifeCycleTemplate) Supports initialization, following construction of an instance.
protected void	initialize(LifeCycleTemplateReference lifeCycleTemplateReference) Supports initialization, following construction of an instance.
protected void	initialize(ObjectIdentifier oid) Supports initialization, following construction of an instance.
boolean	isBasic() Gets the value of the attribute: BASIC.
boolean	isEnabled() Gets the value of the attribute: ENABLED.
static LifeCycleTemplateReference	newLifeCycleTemplateReference() Default constructor Supported API: false
static LifeCycleTemplateReference	newLifeCycleTemplateReference(LifeCycleTemplate lifeCycleTemplate) Transform a LifeCycleTemplate instance into a LifeCycleTemplateReference Supported API: false
static LifeCycleTemplateReference	newLifeCycleTemplateReference(LifeCycleTemplateReference lifeCycleTemplateReference) Transform a LifeCycleTemplateReference instance into a LifeCycleTemplateReference Supported API: false
static LifeCycleTemplateReference	newLifeCycleTemplateReference(ObjectIdentifier oid) Constructs a lifecycle template reference out of its database identifier.
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(LifeCycleTemplateReference thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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.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, newObjectReference, newObjectReference, newObjectReference, newObjectReference, readVersion, references, setKey, setObject, setObjectId, toString

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

NAME

public static final String NAME

Label for the attribute; LifeCycle name inflated from the cache.

Supported API: false

See Also:

Constant Field Values

name

private String name

ENABLED

public static final String ENABLED

Label for the attribute; LifeCycle enabled attribute, inflated from the cache.

Supported API: false

See Also:

Constant Field Values

enabled

private boolean enabled

IDENTITY

public static final String IDENTITY

Label for the attribute; LifeCycle Identity information, inflated from the cache.

Supported API: false

See Also:

Constant Field Values

identity

private String identity

BASIC

public static final String BASIC

Label for the attribute; This attribute is used to specify if the lifecycle template is basic (no roles, ad hoc access, workflows or criteria) or advanced (may contain roles, ad hoc access, access, workfow and criteria).

Supported API: false

See Also:

Constant Field Values

basic

private boolean basic

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

LifeCycleTemplateReference

public LifeCycleTemplateReference()

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 CachedObjectReference

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 CachedObjectReference

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(LifeCycleTemplateReference 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 CachedObjectReference

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 CachedObjectReference

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 ObjectReference

Returns:

String

getName

public String getName()

Gets the value of the attribute: NAME. LifeCycle name inflated from the cache.

Supported API: false

Returns:

String

isEnabled

public boolean isEnabled()

Gets the value of the attribute: ENABLED. LifeCycle enabled attribute, inflated from the cache.

Supported API: false

Returns:

boolean

getIdentity

public String getIdentity()

Gets the value of the attribute: IDENTITY. LifeCycle Identity information, inflated from the cache.

Supported API: false

Returns:

String

isBasic

public boolean isBasic()

Gets the value of the attribute: BASIC. This attribute is used to specify if the lifecycle template is basic (no roles, ad hoc access, workflows or criteria) or advanced (may contain roles, ad hoc access, access, workfow and criteria).

Supported API: false

Returns:

boolean

newLifeCycleTemplateReference

public static LifeCycleTemplateReference newLifeCycleTemplateReference()
                                                                throws WTException

Default constructor

Supported API: false

Returns:

LifeCycleTemplateReference

Throws:

WTException

newLifeCycleTemplateReference

public static LifeCycleTemplateReference newLifeCycleTemplateReference(LifeCycleTemplate lifeCycleTemplate)
                                                                throws WTException

Transform a LifeCycleTemplate instance into a LifeCycleTemplateReference

Supported API: false

Parameters:

lifeCycleTemplate - the LifeCycleTemplate object used in the construction of the LifeCycleTemplateReference

Returns:

LifeCycleTemplateReference

Throws:

WTException

initialize

protected void initialize(LifeCycleTemplate lifeCycleTemplate)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

lifeCycleTemplate - the LifeCycleTemplate object used in the construction of the LifeCycleTemplateReference

Throws:

WTException

newLifeCycleTemplateReference

public static LifeCycleTemplateReference newLifeCycleTemplateReference(LifeCycleTemplateReference lifeCycleTemplateReference)
                                                                throws WTException

Transform a LifeCycleTemplateReference instance into a LifeCycleTemplateReference

Supported API: false

Parameters:

lifeCycleTemplateReference - the LifeCycleTemplateReference object used in the construction of the LifeCycleTemplateReference

Returns:

LifeCycleTemplateReference

Throws:

WTException

initialize

protected void initialize(LifeCycleTemplateReference lifeCycleTemplateReference)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

lifeCycleTemplateReference - the LifeCycleTemplateReference object used in the construction of the LifeCycleTemplateReference

Throws:

WTException

newLifeCycleTemplateReference

public static LifeCycleTemplateReference newLifeCycleTemplateReference(ObjectIdentifier oid)
                                                                throws WTException

Constructs a lifecycle template reference out of its database identifier. Used by externalizable classes to store the reference persistently in the most compact way possible. This is useful when you can only get an ObjectReference using the ReferenceFactory on a readExternal.

Supported API: false

Parameters:

oid - the object id of the LifeCycleTemplate object used in the construction of the LifeCycleTemplateReference

Returns:

LifeCycleTemplateReference

Throws:

WTException

initialize

protected void initialize(ObjectIdentifier oid)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Overrides:

initialize in class ObjectReference

Parameters:

oid - the object id of the LifeCycleTemplate object used in the construction of the LifeCycleTemplateReference

Throws:

WTException

inflate

public void inflate(Persistable obj)

Supported API: false

Specified by:

inflate in class CachedObjectReference

Parameters:

obj -

inflate

public void inflate(CachedObjectReference cor)

Supported API: false

Specified by:

inflate in class CachedObjectReference

Parameters:

cor -

initialize

protected void initialize()
                   throws WTException

Description copied from class: ObjectReference

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Overrides:

initialize in class ObjectReference

Throws:

WTException