wt.maturity
Class MaturityKey

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.fc.SemanticKey
          extended bywt.maturity.MaturityKey
All Implemented Interfaces:
DisplayIdentification, Externalizable, IdentificationObjectNamespace, NetFactor, ObjectMappable, OrganizationOwnedIdentificationObjectNamespace, Persistable, Serializable, WTContainerNamespace

public class MaturityKey
extends SemanticKey
implements WTContainerNamespace, OrganizationOwnedIdentificationObjectNamespace, Externalizable

Use the newMaturityKey static factory method(s), not the MaturityKey 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
           
private  WTContainedIdentified containedIdentified
           
private  WTContainerRef containerReference
           
static long EXTERNALIZATION_VERSION_UID
           
private  WTContainerRef namespaceReference
           
protected static long OLD_FORMAT_VERSION_UID
           
private  WTPrincipalReference organizationReference
           
protected static String PROMOTION_NOTICE_CLASSNAME
          Label for the attribute.
private static int PROMOTION_NOTICE_CLASSNAME_UPPER_LIMIT
           
private  String promotionNoticeClassname
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Fields inherited from class wt.fc.SemanticKey
KEY, UNIQUELY_IDENTIFIED, UNIQUELY_IDENTIFIED_REFERENCE
 
Fields inherited from class wt.fc.WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMP
 
Fields inherited from interface wt.inf.container.WTContainerNamespace
CONTAINED_IDENTIFIED, CONTAINER_REFERENCE, NAMESPACE_ID, NAMESPACE_REFERENCE
 
Fields inherited from interface wt.org.OrganizationOwnedIdentificationObjectNamespace
ORGANIZATION_REFERENCE
 
Fields inherited from interface wt.fc.Persistable
IDENTITY, PERSIST_INFO, TYPE
 
Fields inherited from interface wt.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE
 
Constructor Summary
MaturityKey()
           
 
Method Summary
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.
 String getConceptualClassname()
          Deprecated.  
 WTContainedIdentified getContainedIdentified()
          Gets the value of the attribute: CONTAINED_IDENTIFIED.
 WTContainerRef getContainerReference()
          Gets the value of the attribute: CONTAINER_REFERENCE.
 WTContainerRef getNamespaceReference()
          Gets the value of the attribute: NAMESPACE_REFERENCE.
 WTPrincipalReference getOrganizationReference()
          Gets the value of the attribute: ORGANIZATION_REFERENCE.
protected  String getPromotionNoticeClassname()
          Gets the value of the attribute: PROMOTION_NOTICE_CLASSNAME.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
protected  void initialize(String identity)
          Supports initialization, following construction of an instance.
private  void namespaceReferenceValidate(WTContainerRef a_NamespaceReference)
           
static MaturityKey newMaturityKey(String identity)
          

Supported API: false
private  void organizationReferenceValidate(WTPrincipalReference a_OrganizationReference)
           
private  void promotionNoticeClassnameValidate(String a_PromotionNoticeClassname)
           
 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(MaturityKey thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setContainedIdentified(WTContainedIdentified a_ContainedIdentified)
          Sets the value of the attribute: CONTAINED_IDENTIFIED.
 void setContainerReference(WTContainerRef a_ContainerReference)
          Sets the value of the attribute: CONTAINER_REFERENCE.
 void setNamespaceReference(WTContainerRef a_NamespaceReference)
          Sets the value of the attribute: NAMESPACE_REFERENCE.
 void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
          Sets the value of the attribute: ORGANIZATION_REFERENCE.
protected  void setPromotionNoticeClassname(String a_PromotionNoticeClassname)
          Sets the value of the attribute: PROMOTION_NOTICE_CLASSNAME.
 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.SemanticKey
getKey, getUniquelyIdentified, getUniquelyIdentifiedReference, newSemanticKey, readVersion, setKey, setUniquelyIdentified, setUniquelyIdentifiedReference, toString
 
Methods inherited from class wt.fc.WTObject
checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo
 
Methods inherited from class java.lang.Object
clone, 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

PROMOTION_NOTICE_CLASSNAME

protected static final String PROMOTION_NOTICE_CLASSNAME
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

PROMOTION_NOTICE_CLASSNAME_UPPER_LIMIT

private static int PROMOTION_NOTICE_CLASSNAME_UPPER_LIMIT

promotionNoticeClassname

private String promotionNoticeClassname

containedIdentified

private WTContainedIdentified containedIdentified

containerReference

private WTContainerRef containerReference

namespaceReference

private WTContainerRef namespaceReference

organizationReference

private WTPrincipalReference organizationReference

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

MaturityKey

public MaturityKey()
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 SemanticKey
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 SemanticKey
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

protected boolean readVersion(MaturityKey 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 SemanticKey
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 SemanticKey
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 SemanticKey
Returns:
String

getPromotionNoticeClassname

protected String getPromotionNoticeClassname()
Gets the value of the attribute: PROMOTION_NOTICE_CLASSNAME.

Supported API: false

Returns:
String

setPromotionNoticeClassname

protected void setPromotionNoticeClassname(String a_PromotionNoticeClassname)
                                    throws WTPropertyVetoException
Sets the value of the attribute: PROMOTION_NOTICE_CLASSNAME.

Supported API: false

Parameters:
a_PromotionNoticeClassname -
Throws:
WTPropertyVetoException

promotionNoticeClassnameValidate

private void promotionNoticeClassnameValidate(String a_PromotionNoticeClassname)
                                       throws WTPropertyVetoException
Parameters:
a_PromotionNoticeClassname -
Throws:
WTPropertyVetoException

newMaturityKey

public static MaturityKey newMaturityKey(String identity)
                                  throws WTException


Supported API: false

Parameters:
identity -
Returns:
MaturityKey
Throws:
WTException

initialize

protected void initialize(String identity)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Overrides:
initialize in class SemanticKey
Parameters:
identity -
Throws:
WTException

getContainedIdentified

public WTContainedIdentified getContainedIdentified()
Gets the value of the attribute: CONTAINED_IDENTIFIED. A callback to the WTContainedIdentified object that this is a namespace for. This property is used internally and never needs to be set by callers.

Supported API: false

Specified by:
getContainedIdentified in interface WTContainerNamespace
Returns:
WTContainedIdentified

setContainedIdentified

public void setContainedIdentified(WTContainedIdentified a_ContainedIdentified)
                            throws WTPropertyVetoException
Sets the value of the attribute: CONTAINED_IDENTIFIED. A callback to the WTContainedIdentified object that this is a namespace for. This property is used internally and never needs to be set by callers.

Supported API: false

Specified by:
setContainedIdentified in interface WTContainerNamespace
Parameters:
a_ContainedIdentified -
Throws:
WTPropertyVetoException

getContainerReference

public WTContainerRef getContainerReference()
Gets the value of the attribute: CONTAINER_REFERENCE. The container that the WTContainedIdentified object is contained by. Setting this property and then calling IdentityService.changeIdentity will update the object's container reference.

Supported API: false

Specified by:
getContainerReference in interface WTContainerNamespace
Returns:
WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException
Sets the value of the attribute: CONTAINER_REFERENCE. The container that the WTContainedIdentified object is contained by. Setting this property and then calling IdentityService.changeIdentity will update the object's container reference.

Supported API: false

Specified by:
setContainerReference in interface WTContainerNamespace
Parameters:
a_ContainerReference -
Throws:
WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException
Parameters:
a_ContainerReference -
Throws:
WTPropertyVetoException

getNamespaceReference

public WTContainerRef getNamespaceReference()
Gets the value of the attribute: NAMESPACE_REFERENCE. This property is used internally by the container service's identity processing. Callers should never need to set it.

A reference to the WTContainer that serves as a namespace for the WTContainedIdentified object. This value is typically derivable from WTContainerHelper.service.getNamespace, except for situations where a container and its children are being re-namespaced as part of a single transaction.

Supported API: false

Specified by:
getNamespaceReference in interface WTContainerNamespace
Returns:
WTContainerRef

setNamespaceReference

public void setNamespaceReference(WTContainerRef a_NamespaceReference)
                           throws WTPropertyVetoException
Sets the value of the attribute: NAMESPACE_REFERENCE. This property is used internally by the container service's identity processing. Callers should never need to set it.

A reference to the WTContainer that serves as a namespace for the WTContainedIdentified object. This value is typically derivable from WTContainerHelper.service.getNamespace, except for situations where a container and its children are being re-namespaced as part of a single transaction.

Supported API: false

Specified by:
setNamespaceReference in interface WTContainerNamespace
Parameters:
a_NamespaceReference -
Throws:
WTPropertyVetoException

namespaceReferenceValidate

private void namespaceReferenceValidate(WTContainerRef a_NamespaceReference)
                                 throws WTPropertyVetoException
Parameters:
a_NamespaceReference -
Throws:
WTPropertyVetoException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()
Gets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: false

Specified by:
getOrganizationReference in interface OrganizationOwnedIdentificationObjectNamespace
Returns:
WTPrincipalReference

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
                              throws WTPropertyVetoException
Sets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: false

Specified by:
setOrganizationReference in interface OrganizationOwnedIdentificationObjectNamespace
Parameters:
a_OrganizationReference -
Throws:
WTPropertyVetoException

organizationReferenceValidate

private void organizationReferenceValidate(WTPrincipalReference a_OrganizationReference)
                                    throws WTPropertyVetoException
Parameters:
a_OrganizationReference -
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 SemanticKey
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 SemanticKey
Returns:
int