wt.inf.template
Class WTContainerTemplateMaster

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Master
          wt.inf.template.WTContainerTemplateMaster

All Implemented Interfaces:

BusinessInformation, ContainerDefinition, ContainerTemplateDefinition, DisplayIdentification, Externalizable, Identified, Mastered, NetFactor, ObjectMappable, Persistable, RecentlyVisited, Serializable, WTContained

public final class WTContainerTemplateMaster

extends Master

implements ContainerDefinition, WTContained, Identified, Externalizable

Use the newWTContainerTemplateMaster static factory method(s), not the WTContainerTemplateMaster 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: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
static String	CONTAINER_CLASS_NAME Label for the attribute.
private static int	CONTAINER_CLASS_NAME_UPPER_LIMIT
private String	containerClassName
private WTContainerRef	containerReference
private String	description
static String	DESCRIPTION Label for the attribute.
private static int	DESCRIPTION_UPPER_LIMIT
private boolean	enabled
static String	ENABLED Label for the attribute.
static long	EXTERNALIZATION_VERSION_UID
private String	locale
static String	LOCALE Label for the attribute; This enables filtered queries based on locale.
private static int	LOCALE_UPPER_LIMIT
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.enterprise.Master

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.vc.Mastered

SERIES

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WTContainerTemplateMaster()

Method Summary

private void	containerClassNameValidate(String a_ContainerClassName)
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
private void	descriptionValidate(String a_Description)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerClassName() Gets the value of the attribute: CONTAINER_CLASS_NAME.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
DefaultWTContainerTemplate	getContainerTemplate() Deprecated.
ObjectReference	getContainerTemplateReference() Deprecated.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getIdentity() Returns a string that can be displayed to the user to identify the object.
String	getLocale() Gets the value of the attribute: LOCALE.
String	getName() Gets the value of the attribute: NAME.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name, Class a_containerClass) Supports initialization, following construction of an instance.
protected void	initialize(String name, String containerClassName) Supports initialization, following construction of an instance.
boolean	isEnabled() Gets the value of the attribute: ENABLED.
private void	localeValidate(String a_Locale)
private void	nameValidate(String a_Name)
static WTContainerTemplateMaster	newWTContainerTemplateMaster() Supported API: false
static WTContainerTemplateMaster	newWTContainerTemplateMaster(String name, Class a_containerClass) Supported API: false
static WTContainerTemplateMaster	newWTContainerTemplateMaster(String name, String containerClassName) Supported API: false
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(WTContainerTemplateMaster thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerClassName(String a_ContainerClassName) Sets the value of the attribute: CONTAINER_CLASS_NAME.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setEnabled(boolean a_Enabled) Sets the value of the attribute: ENABLED.
protected void	setIdentificationObject(WTContainerTemplateMasterIdentity identity) Supported API: false
protected void	setIdentity(String name) Sets the identity of the template.
void	setLocale(String a_Locale) Sets the value of the attribute: LOCALE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
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.enterprise.Master

getBusinessType, getSeries, readVersion, setSeries

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

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.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

ENABLED

public static final String ENABLED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

enabled

private boolean enabled

CONTAINER_CLASS_NAME

public static final String CONTAINER_CLASS_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CONTAINER_CLASS_NAME_UPPER_LIMIT

private static int CONTAINER_CLASS_NAME_UPPER_LIMIT

containerClassName

private String containerClassName

LOCALE

public static final String LOCALE

Label for the attribute; This enables filtered queries based on locale. The default is that it will show up in all queries.

Supported API: false

See Also:

Constant Field Values

LOCALE_UPPER_LIMIT

private static int LOCALE_UPPER_LIMIT

locale

private String locale

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

WTContainerTemplateMaster

public WTContainerTemplateMaster()

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 Master

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 Master

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 Master

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

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

isEnabled

public boolean isEnabled()

Gets the value of the attribute: ENABLED.

Supported API: false

Returns:

boolean

setEnabled

public void setEnabled(boolean a_Enabled)
                throws WTPropertyVetoException

Sets the value of the attribute: ENABLED.

Supported API: false

Parameters:

a_Enabled -

Throws:

WTPropertyVetoException

getContainerClassName

public String getContainerClassName()

Gets the value of the attribute: CONTAINER_CLASS_NAME.

Supported API: false

Returns:

String

setContainerClassName

public void setContainerClassName(String a_ContainerClassName)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_CLASS_NAME.

Supported API: false

Parameters:

a_ContainerClassName -

Throws:

WTPropertyVetoException

containerClassNameValidate

private void containerClassNameValidate(String a_ContainerClassName)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerClassName -

Throws:

WTPropertyVetoException

getLocale

public String getLocale()

Gets the value of the attribute: LOCALE. This enables filtered queries based on locale. The default is that it will show up in all queries.

Supported API: false

Returns:

String

setLocale

public void setLocale(String a_Locale)
               throws WTPropertyVetoException

Sets the value of the attribute: LOCALE. This enables filtered queries based on locale. The default is that it will show up in all queries.

Supported API: false

Parameters:

a_Locale -

Throws:

WTPropertyVetoException

localeValidate

private void localeValidate(String a_Locale)
                     throws WTPropertyVetoException

Parameters:

a_Locale -

Throws:

WTPropertyVetoException

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: false

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

setIdentificationObject

protected void setIdentificationObject(WTContainerTemplateMasterIdentity identity)
                                throws WTException

Supported API: false

Parameters:

identity -

Throws:

WTException

setIdentity

protected void setIdentity(String name)
                    throws WTException

Sets the identity of the template. Used to change the identity by the IndentityService after a request is made to change the identity of the object.

Supported API: false

Parameters:

name -

Throws:

WTException

See Also:

IdentityService

getIdentity

public String getIdentity()

Returns a string that can be displayed to the user to identify the object. WTObject implements a default method that returns a string representation of this object's identifier.

Supported API: false

Specified by:

getIdentity in interface Persistable

Overrides:

getIdentity in class Master

Returns:

String

newWTContainerTemplateMaster

public static WTContainerTemplateMaster newWTContainerTemplateMaster(String name,
                                                                     String containerClassName)
                                                              throws WTException

Supported API: false

Parameters:

name -

containerClassName -

Returns:

WTContainerTemplateMaster

Throws:

WTException

initialize

protected void initialize(String name,
                          String containerClassName)
                   throws WTException

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

Supported API: false

Parameters:

name -

containerClassName -

Throws:

WTException

newWTContainerTemplateMaster

public static WTContainerTemplateMaster newWTContainerTemplateMaster(String name,
                                                                     Class a_containerClass)
                                                              throws WTException

Supported API: false

Parameters:

name -

a_containerClass -

Returns:

WTContainerTemplateMaster

Throws:

WTException

initialize

protected void initialize(String name,
                          Class a_containerClass)
                   throws WTException

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

Supported API: false

Parameters:

name -

a_containerClass -

Throws:

WTException

newWTContainerTemplateMaster

public static WTContainerTemplateMaster newWTContainerTemplateMaster()
                                                              throws WTException

Supported API: false

Returns:

WTContainerTemplateMaster

Throws:

WTException

getContainerTemplate

public DefaultWTContainerTemplate getContainerTemplate()

Deprecated.

This method is deprecated, use ContainerHelper.getContainerTemplate(ContainerDefinition def) instead.

Supported API: false

Specified by:

getContainerTemplate in interface ContainerTemplateDefinition

Returns:

DefaultWTContainerTemplate

getContainerTemplateReference

public ObjectReference getContainerTemplateReference()

Deprecated.

deprecated, use ContainerHelper.service.getContainerTemplateRef(ContainerDefinition def) instead.

Supported API: false

Specified by:

getContainerTemplateReference in interface ContainerTemplateDefinition

Returns:

ObjectReference

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

Overrides:

equals in class Master

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

Overrides:

hashCode in class Master

Returns:

int