wt.enterprise
Class TemplateInfo

java.lang.Object
  wt.enterprise.TemplateInfo

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Serializable

public class TemplateInfo

extends Object

implements ObjectMappable, Externalizable

TemplateInfo is the 'cookie' of the Templateable interface, that encapsulates the implementation of a template.

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

TemplateInfo, Templateable, Serialized Form

Field Summary

private static String	CLASSNAME
private boolean	enabled
static String	ENABLED Label for the attribute; Boolean flag indicating whether a template is enabled or not.
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private boolean	templated
static String	TEMPLATED Label for the attribute; Boolean flag indicating whether template or not.

Constructor Summary

TemplateInfo()

Method Summary

ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
protected void	initialize() Supports initialization, following construction of an instance.
boolean	isEnabled() Gets the value of the attribute: ENABLED.
boolean	isTemplated() Gets the value of the attribute: TEMPLATED.
static TemplateInfo	newTemplateInfo() Default factory for the class.
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(TemplateInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: ENABLED.
void	setTemplated(boolean a_Templated) Sets the value of the attribute: TEMPLATED.
String	toString() Returns the conceptual (modeled) name for the class.
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 java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

TEMPLATED

public static final String TEMPLATED

Label for the attribute; Boolean flag indicating whether template or not.

Supported API: false

See Also:

Constant Field Values

templated

private boolean templated

ENABLED

public static final String ENABLED

Label for the attribute; Boolean flag indicating whether a template is enabled or not. This flag is used to flag a template for use.

Supported API: false

See Also:

Constant Field Values

enabled

private boolean enabled

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

TemplateInfo

public TemplateInfo()

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

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

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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

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

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

isTemplated

public boolean isTemplated()

Gets the value of the attribute: TEMPLATED. Boolean flag indicating whether template or not.

Supported API: false

Returns:

boolean

setTemplated

public void setTemplated(boolean a_Templated)

Sets the value of the attribute: TEMPLATED. Boolean flag indicating whether template or not.

Supported API: false

Parameters:

a_Templated -

isEnabled

public boolean isEnabled()

Gets the value of the attribute: ENABLED. Boolean flag indicating whether a template is enabled or not. This flag is used to flag a template for use.

Supported API: false

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)

Sets the value of the attribute: ENABLED. Boolean flag indicating whether a template is enabled or not. This flag is used to flag a template for use.

Supported API: false

Parameters:

a_Enabled -

newTemplateInfo

public static TemplateInfo newTemplateInfo()
                                    throws WTException

Default factory for the class.

Supported API: false

Returns:

TemplateInfo

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

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

Supported API: false

Throws:

WTException