wt.viewmarkup
Class WVSConfigurationTemplate

java.lang.Object
  wt.viewmarkup.WVSConfigurationTemplate

All Implemented Interfaces:

ContentHolder, Externalizable, NetFactor, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained

public class WVSConfigurationTemplate

extends Object

implements ContentHolder, WTContained, Externalizable

Use the newWVSConfigurationTemplate static factory method(s), not the WVSConfigurationTemplate 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

Field Summary

private static String	CLASSNAME
static String	CONFIGURATION_TYPE Label for the attribute; The configurationType will be used somewhat like a name, but without the implied notion that a name can be easily changed without any sideaffects Supported API: false
private static int	CONFIGURATION_TYPE_UPPER_LIMIT
private String	configurationType
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
private Vector	contentVector
static long	EXTERNALIZATION_VERSION_UID
private boolean	hasContents
private Vector	httpVector
protected static long	OLD_FORMAT_VERSION_UID
private HttpContentOperation	operation
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Constructor Summary

WVSConfigurationTemplate()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	configurationTypeValidate(String a_ConfigurationType)
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
String	getConfigurationType() Gets the value of the attribute: CONFIGURATION_TYPE.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
Vector	getContentVector() Gets the value of the attribute: CONTENT_VECTOR.
Vector	getHttpVector() Gets the value of the attribute: HTTP_VECTOR.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
HttpContentOperation	getOperation() Gets the value of the attribute: OPERATION.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supports initialization, following construction of an instance.
boolean	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
static WVSConfigurationTemplate	newWVSConfigurationTemplate() 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(WVSConfigurationTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setConfigurationType(String a_ConfigurationType) Sets the value of the attribute: CONFIGURATION_TYPE.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setContentVector(Vector a_ContentVector) Sets the value of the attribute: CONTENT_VECTOR.
void	setHasContents(boolean a_HasContents) Sets the value of the attribute: HAS_CONTENTS.
void	setHttpVector(Vector a_HttpVector) Sets the value of the attribute: HTTP_VECTOR.
void	setOperation(HttpContentOperation a_Operation) Sets the value of the attribute: OPERATION.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
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, 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

CONFIGURATION_TYPE

public static final String CONFIGURATION_TYPE

Label for the attribute; The configurationType will be used somewhat like a name, but without the implied notion that a name can be easily changed without any sideaffects

Supported API: false

See Also:

Constant Field Values

CONFIGURATION_TYPE_UPPER_LIMIT

private static int CONFIGURATION_TYPE_UPPER_LIMIT

configurationType

private String configurationType

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

thePersistInfo

private PersistInfo thePersistInfo

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

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

WVSConfigurationTemplate

public WVSConfigurationTemplate()

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(WVSConfigurationTemplate 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

getConfigurationType

public String getConfigurationType()

Gets the value of the attribute: CONFIGURATION_TYPE. The configurationType will be used somewhat like a name, but without the implied notion that a name can be easily changed without any sideaffects

Supported API: false

Returns:

String

setConfigurationType

public void setConfigurationType(String a_ConfigurationType)
                          throws WTPropertyVetoException

Sets the value of the attribute: CONFIGURATION_TYPE. The configurationType will be used somewhat like a name, but without the implied notion that a name can be easily changed without any sideaffects

Supported API: false

Parameters:

a_ConfigurationType -

Throws:

WTPropertyVetoException

configurationTypeValidate

private void configurationTypeValidate(String a_ConfigurationType)
                                throws WTPropertyVetoException

Parameters:

a_ConfigurationType -

Throws:

WTPropertyVetoException

newWVSConfigurationTemplate

public static WVSConfigurationTemplate newWVSConfigurationTemplate()
                                                            throws WTException

Default factory for the class.

Supported API: false

Returns:

WVSConfigurationTemplate

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

getContentVector

public Vector getContentVector()

Gets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getContentVector in interface ContentHolder

Returns:

Vector

setContentVector

public void setContentVector(Vector a_ContentVector)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setContentVector in interface ContentHolder

Parameters:

a_ContentVector -

Throws:

WTPropertyVetoException

isHasContents

public boolean isHasContents()

Gets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

isHasContents in interface ContentHolder

Returns:

boolean

setHasContents

public void setHasContents(boolean a_HasContents)
                    throws WTPropertyVetoException

Sets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

setHasContents in interface ContentHolder

Parameters:

a_HasContents -

Throws:

WTPropertyVetoException

getOperation

public HttpContentOperation getOperation()

Gets the value of the attribute: OPERATION.

Supported API: false

Specified by:

getOperation in interface ContentHolder

Returns:

HttpContentOperation

setOperation

public void setOperation(HttpContentOperation a_Operation)
                  throws WTPropertyVetoException

Sets the value of the attribute: OPERATION.

Supported API: false

Specified by:

setOperation in interface ContentHolder

Parameters:

a_Operation -

Throws:

WTPropertyVetoException

getHttpVector

public Vector getHttpVector()

Gets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getHttpVector in interface ContentHolder

Returns:

Vector

setHttpVector

public void setHttpVector(Vector a_HttpVector)
                   throws WTPropertyVetoException

Sets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setHttpVector in interface ContentHolder

Parameters:

a_HttpVector -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

Gets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

Sets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getContainer

public WTContainer getContainer()

Gets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

getContainer in interface WTContained

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

Sets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

setContainer in interface WTContained

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContained

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Returns:

int