wt.epm
Class EPMCADNamespace

java.lang.Object
  wt.epm.EPMCADNamespace

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class EPMCADNamespace

extends Object

implements Persistable, Externalizable

EPMCADNamespace is to restrict a unique CAD name in the context of a project or PDM. When a CAD document is created in PDM or in a sandbox project, its CAD name along with the container will be added. When a CAD document is shared to a given sandbox project, its CAD Name and the sandbox project will be added. When a CAD document is deleted or no longer shared to a project, its namespace entry will be deleted. Although the CAD document's master reference is not needed in the namespace, it is used to identify how the CAD name is added to a given namespace. In addition, the master reference can be used to determine whether the CAD name entry is a shared object or actually resides in the container.

Use the newEPMCADNamespace static factory method(s), not the EPMCADNamespace 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 String	CADName
static String	CADNAME Label for the attribute; TheCAD name of the document..
private static int	CADNAME_UPPER_LIMIT
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	MASTER Label for the attribute.
static String	MASTER_REFERENCE Label for the attribute.
private ObjectReference	masterReference
protected static long	OLD_FORMAT_VERSION_UID
static String	PROJECT Label for the attribute; A null project reference means PDM container.
static String	PROJECT_REFERENCE Label for the attribute; A null project reference means PDM container.
private ObjectReference	projectReference
private static String	RESOURCE
(package private) static long	serialVersionUID
private PersistInfo	thePersistInfo

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

EPMCADNamespace()

Method Summary

private void	CADNameValidate(String a_CADName)
void	checkAttributes() Validate the values of this Persistable object's attributes.
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	getCADName() Gets the value of the attribute: CADNAME.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
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().
EPMDocumentMaster	getMaster() Gets the object for the association that plays role: MASTER.
ObjectReference	getMasterReference() Gets the value of the attribute: MASTER_REFERENCE.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
WTContainer	getProject() Gets the object for the association that plays role: PROJECT.
ObjectReference	getProjectReference() Gets the value of the attribute: PROJECT_REFERENCE.
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(ObjectReference masterReference, ObjectReference projectReference, String CADName) Supports initialization, following construction of an instance.
private void	masterReferenceValidate(ObjectReference a_MasterReference)
static EPMCADNamespace	newEPMCADNamespace(ObjectReference masterReference, ObjectReference projectReference, String CADName) Supported API: false
private void	projectReferenceValidate(ObjectReference a_ProjectReference)
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(EPMCADNamespace thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCADName(String a_CADName) Sets the value of the attribute: CADNAME.
void	setMaster(EPMDocumentMaster a_Master) Sets the object for the association that plays role: MASTER.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
void	setProject(WTContainer a_Project) Sets the object for the association that plays role: PROJECT.
void	setProjectReference(ObjectReference a_ProjectReference) Sets the value of the attribute: PROJECT_REFERENCE.
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

CADNAME

public static final String CADNAME

Label for the attribute; TheCAD name of the document..

Supported API: true

See Also:

Constant Field Values

CADNAME_UPPER_LIMIT

private static int CADNAME_UPPER_LIMIT

CADName

private String CADName

MASTER

public static final String MASTER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MASTER_REFERENCE

public static final String MASTER_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

masterReference

private ObjectReference masterReference

PROJECT

public static final String PROJECT

Label for the attribute; A null project reference means PDM container.

Supported API: false

See Also:

Constant Field Values

PROJECT_REFERENCE

public static final String PROJECT_REFERENCE

Label for the attribute; A null project reference means PDM container.

Supported API: false

See Also:

Constant Field Values

projectReference

private ObjectReference projectReference

thePersistInfo

private PersistInfo thePersistInfo

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

EPMCADNamespace

public EPMCADNamespace()

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

getCADName

public String getCADName()

Gets the value of the attribute: CADNAME. TheCAD name of the document..

Supported API: true

Returns:

String

setCADName

public void setCADName(String a_CADName)
                throws WTPropertyVetoException

Sets the value of the attribute: CADNAME. TheCAD name of the document..

Supported API: true

Parameters:

a_CADName -

Throws:

WTPropertyVetoException

CADNameValidate

private void CADNameValidate(String a_CADName)
                      throws WTPropertyVetoException

Parameters:

a_CADName -

Throws:

WTPropertyVetoException

getMaster

public EPMDocumentMaster getMaster()

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

Supported API: false

Returns:

EPMDocumentMaster

setMaster

public void setMaster(EPMDocumentMaster a_Master)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

getMasterReference

public ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE.

Supported API: false

Returns:

ObjectReference

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: false

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

getProject

public WTContainer getProject()

Gets the object for the association that plays role: PROJECT. A null project reference means PDM container.

Supported API: false

Returns:

WTContainer

setProject

public void setProject(WTContainer a_Project)
                throws WTPropertyVetoException,
                       WTException

Sets the object for the association that plays role: PROJECT. A null project reference means PDM container.

Supported API: false

Parameters:

a_Project -

Throws:

WTPropertyVetoException

WTException

getProjectReference

public ObjectReference getProjectReference()

Gets the value of the attribute: PROJECT_REFERENCE. A null project reference means PDM container.

Supported API: false

Returns:

ObjectReference

setProjectReference

public void setProjectReference(ObjectReference a_ProjectReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: PROJECT_REFERENCE. A null project reference means PDM container.

Supported API: false

Parameters:

a_ProjectReference -

Throws:

WTPropertyVetoException

projectReferenceValidate

private void projectReferenceValidate(ObjectReference a_ProjectReference)
                               throws WTPropertyVetoException

Parameters:

a_ProjectReference -

Throws:

WTPropertyVetoException

newEPMCADNamespace

public static EPMCADNamespace newEPMCADNamespace(ObjectReference masterReference,
                                                 ObjectReference projectReference,
                                                 String CADName)
                                          throws WTException

Supported API: false

Parameters:

masterReference -

projectReference -

CADName -

Returns:

EPMCADNamespace

Throws:

WTException

initialize

protected void initialize(ObjectReference masterReference,
                          ObjectReference projectReference,
                          String CADName)
                   throws WTException

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

Supported API: false

Parameters:

masterReference -

projectReference -

CADName -

Throws:

WTException

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 -

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