wt.change2
Class WTAnalysisActivity

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.CabinetManaged
          wt.change2.AnalysisActivity
              wt.change2.WTAnalysisActivity

All Implemented Interfaces:

AccessControlled, AccessControlList, AdHocControlled, AnalysisActivityIfc, CabinetBased, CabinetMember, ChangeItem, ChangeItemIfc, ContentHolder, DisplayIdentification, DomainAdministered, ElectronicallySignable, Externalizable, FolderEntry, FolderServiceManaged, IBAHolder, Identified, Indexable, LifeCycleManaged, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, RecentlyVisited, Serializable, TeamManaged, Typed, UniquelyIdentified, WTContained, WTContainedIdentified

public class WTAnalysisActivity

extends AnalysisActivity

implements Typed, UniquelyIdentified, Externalizable

A Windchill provided reference implementation of an AnalysisActivity. Depending on its suitability, the site may use it as is, extend it or disregard it entirely and extend the abstract AnalysisActivity class instead.

Each WTAnalysisActivity instance is assigned a unique number which is generated by the system when the analysis activity is stored in the database.

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

See Also:

WTAnalysisActivityIdentity, Serialized Form

Field Summary

private static String	CLASSNAME
private String	description
static String	DESCRIPTION Label for the attribute; Description of the activity to be performed.
private static int	DESCRIPTION_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
private String	name
static String	NAME Label for the attribute; An end-user provided name for this WTAnalysisActivity.
private static int	NAME_UPPER_LIMIT
static String	NEED_DATE Label for the attribute; Date when the results are needed.
private Timestamp	needDate
private String	number
static String	NUMBER Label for the attribute; A unique number assigned to this WTAnalysisActivity when it is first stored in database.
private static int	NUMBER_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
private String	results
static String	RESULTS Label for the attribute; A description of the results of the action performed.
private static int	RESULTS_UPPER_LIMIT
(package private) static long	serialVersionUID
private AttributeContainer	theAttributeContainer
private TypeDefinitionReference	typeDefinitionReference

Fields inherited from class wt.change2.AnalysisActivity

CONTAINER, R51_EXTERNALIZATION_VERSION_UID

Fields inherited from class wt.enterprise.CabinetManaged

CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.type.Typed

TYPE_DEFINITION_REFERENCE

Fields inherited from interface wt.iba.value.IBAHolder

ATTRIBUTE_CONTAINER

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.inf.container.WTContainedIdentified

CONTAINER_REFERENCE

Fields inherited from interface wt.lifecycle.LifeCycleManaged

LIFE_CYCLE_AT_GATE, LIFE_CYCLE_BASIC, LIFE_CYCLE_NAME, LIFE_CYCLE_STATE, LIFE_CYCLE_TEMPLATE, STATE

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.team.TeamManaged

TEAM_ID, TEAM_IDENTITY, TEAM_NAME, TEAM_TEMPLATE_ID, TEAM_TEMPLATE_IDENTITY, TEAM_TEMPLATE_NAME

Fields inherited from interface wt.index.Indexable

INDEXER_SET

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.folder.CabinetMember

CABINET

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WTAnalysisActivity()

Method Summary

void	checkAttributes() Validate that the name attribute has user supplied values.
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.
AttributeContainer	getAttributeContainer() Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.
String	getConceptualClassname() Deprecated.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getName() Gets the value of the attribute: NAME.
Timestamp	getNeedDate() Gets the value of the attribute: NEED_DATE.
String	getNumber() Gets the value of the attribute: NUMBER.
String	getResults() Gets the value of the attribute: RESULTS.
TypeDefinitionReference	getTypeDefinitionReference() Gets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name) Supports initialization, following construction of an instance.
static WTAnalysisActivity	newWTAnalysisActivity() A no-arg new-factory method to construct an initialized instance of a WTAnalysisActivity.
static WTAnalysisActivity	newWTAnalysisActivity(String name) A new-factory method that construct an initialized instance of a WTAnalysisActivity with the given name.
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(WTAnalysisActivity thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	resultsValidate(String a_Results)
void	setAttributeContainer(AttributeContainer a_AttributeContainer) Sets the object for the association that plays role: ATTRIBUTE_CONTAINER.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
protected void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setNeedDate(Timestamp a_NeedDate) Sets the value of the attribute: NEED_DATE.
protected void	setNumber(String a_Number) Sets the value of the attribute: NUMBER.
void	setResults(String a_Results) Sets the value of the attribute: RESULTS.
void	setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference) Sets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
private void	typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
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.change2.AnalysisActivity

getContainer, getContainerName, getContainerReference, getContentVector, getHttpVector, getOperation, isHasContents, readVersion, setContainer, setContainerReference, setContentVector, setHasContents, setHttpVector, setOperation

Methods inherited from class wt.enterprise.CabinetManaged

getCabinet, getCabinetReference, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEntrySet, getEventSet, getFolderPath, getIndexerSet, getLifeCycleName, getLifeCycleState, getLifeCycleTemplate, getLocation, getOwnership, getState, getTeamId, getTeamIdentity, getTeamName, getTeamTemplateId, getTeamTemplateIdentity, getTeamTemplateName, initialize, isInheritedDomain, isLifeCycleAtGate, isLifeCycleBasic, readVersion, setCabinet, setCreator, setDomainRef, setEntrySet, setEventSet, setIndexerSet, setInheritedDomain, setOwnership, setState, setTeamId, setTeamTemplateId

Methods inherited from class wt.fc.WTObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

getIdentity, 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

NUMBER

public static final String NUMBER

Label for the attribute; A unique number assigned to this WTAnalysisActivity when it is first stored in database.

Supported API: true

See Also:

WTAnalysisActivityIdentity, Constant Field Values

NUMBER_UPPER_LIMIT

private static int NUMBER_UPPER_LIMIT

number

private String number

NAME

public static final String NAME

Label for the attribute; An end-user provided name for this WTAnalysisActivity.

Supported API: true

See Also:

WTAnalysisActivityIdentity, 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; Description of the activity to be performed.

Supported API: true

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

NEED_DATE

public static final String NEED_DATE

Label for the attribute; Date when the results are needed.

Supported API: true

See Also:

Constant Field Values

needDate

private Timestamp needDate

RESULTS

public static final String RESULTS

Label for the attribute; A description of the results of the action performed.

Supported API: true

See Also:

Constant Field Values

RESULTS_UPPER_LIMIT

private static int RESULTS_UPPER_LIMIT

results

private String results

typeDefinitionReference

private TypeDefinitionReference typeDefinitionReference

theAttributeContainer

private AttributeContainer theAttributeContainer

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

WTAnalysisActivity

public WTAnalysisActivity()

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 AnalysisActivity

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 AnalysisActivity

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 AnalysisActivity

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

getNumber

public String getNumber()

Gets the value of the attribute: NUMBER. A unique number assigned to this WTAnalysisActivity when it is first stored in database.

Supported API: true

Returns:

String

See Also:

WTAnalysisActivityIdentity

setNumber

protected void setNumber(String a_Number)

Sets the value of the attribute: NUMBER. A unique number assigned to this WTAnalysisActivity when it is first stored in database.

Supported API: true

Parameters:

a_Number -

See Also:

WTAnalysisActivityIdentity

getName

public String getName()

Gets the value of the attribute: NAME. An end-user provided name for this WTAnalysisActivity.

Supported API: true

Specified by:

getName in interface CabinetBased

Overrides:

getName in class CabinetManaged

Returns:

String

See Also:

WTAnalysisActivityIdentity

setName

protected void setName(String a_Name)

Sets the value of the attribute: NAME. An end-user provided name for this WTAnalysisActivity.

Supported API: true

Parameters:

a_Name -

See Also:

WTAnalysisActivityIdentity

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. Description of the activity to be performed.

Supported API: true

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. Description of the activity to be performed.

Supported API: true

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getNeedDate

public Timestamp getNeedDate()

Gets the value of the attribute: NEED_DATE. Date when the results are needed.

Supported API: true

Returns:

Timestamp

setNeedDate

public void setNeedDate(Timestamp a_NeedDate)
                 throws WTPropertyVetoException

Sets the value of the attribute: NEED_DATE. Date when the results are needed.

Supported API: true

Parameters:

a_NeedDate -

Throws:

WTPropertyVetoException

getResults

public String getResults()

Gets the value of the attribute: RESULTS. A description of the results of the action performed.

Supported API: true

Returns:

String

setResults

public void setResults(String a_Results)
                throws WTPropertyVetoException

Sets the value of the attribute: RESULTS. A description of the results of the action performed.

Supported API: true

Parameters:

a_Results -

Throws:

WTPropertyVetoException

resultsValidate

private void resultsValidate(String a_Results)
                      throws WTPropertyVetoException

Parameters:

a_Results -

Throws:

WTPropertyVetoException

newWTAnalysisActivity

public static WTAnalysisActivity newWTAnalysisActivity()
                                                throws WTException

A no-arg new-factory method to construct an initialized instance of a WTAnalysisActivity.

Supported API: true

Returns:

WTAnalysisActivity

Throws:

WTException

newWTAnalysisActivity

public static WTAnalysisActivity newWTAnalysisActivity(String name)
                                                throws WTException

A new-factory method that construct an initialized instance of a WTAnalysisActivity with the given name.

Supported API: true

Parameters:

name -

Returns:

WTAnalysisActivity

Throws:

WTException

initialize

protected void initialize(String name)
                   throws WTException

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

Supported API: true

Parameters:

name -

Throws:

WTException

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate that the name attribute has user supplied values.

Supported API: true

Specified by:

checkAttributes in interface Persistable

Overrides:

checkAttributes in class WTObject

Throws:

InvalidAttributeException

getTypeDefinitionReference

public TypeDefinitionReference getTypeDefinitionReference()

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

Supported API: false

Specified by:

getTypeDefinitionReference in interface Typed

Returns:

TypeDefinitionReference

setTypeDefinitionReference

public void setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference)
                                throws WTPropertyVetoException

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

Supported API: false

Specified by:

setTypeDefinitionReference in interface Typed

Parameters:

a_TypeDefinitionReference -

Throws:

WTPropertyVetoException

typeDefinitionReferenceValidate

private void typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
                                      throws WTPropertyVetoException

Parameters:

a_TypeDefinitionReference -

Throws:

WTPropertyVetoException

getAttributeContainer

public AttributeContainer getAttributeContainer()

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

Supported API: false

Specified by:

getAttributeContainer in interface IBAHolder

Returns:

AttributeContainer

setAttributeContainer

public void setAttributeContainer(AttributeContainer a_AttributeContainer)

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

Supported API: false

Specified by:

setAttributeContainer in interface IBAHolder

Parameters:

a_AttributeContainer -

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 AnalysisActivity

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 AnalysisActivity

Returns:

int

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Description copied from interface: Identified

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

Supported API: true

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException