wt.change2
Class WTChangeProposal

java.lang.Object
  extended by wt.fc.WTObject
      extended by wt.change2.VersionableChangeItem
          extended by wt.change2.ChangeAnalysis
              extended by wt.change2.ChangeProposal
                  extended by wt.change2.WTChangeProposal
All Implemented Interfaces:
Externalizable, Serializable, AccessControlled, wt.access.AccessControlList, wt.access.AdHocControlled, IdentityAccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, ChangeAnalysisIfc, ChangeItem, ChangeItemIfc, ChangeProposalIfc, ContentHolder, NetFactor, ObjectMappable, Persistable, CabinetBased, CabinetMember, FolderEntry, wt.folder.FolderServiceManaged, wt.iba.value.IBAHolder, DisplayIdentification, Indexable, WTContained, IteratedLifeCycleManaged, wt.lifecycle.LifeCycleManaged, Notifiable, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, OrganizationOwnedVersion, Ownable, wt.recent.RecentlyVisited, wt.team.TeamManaged, wt.type.FlexTyped, wt.type.Typed, Baselineable, Iterated, OneOffVersioned, Versionable, Versioned

public class WTChangeProposal
extends ChangeProposal
implements wt.type.Typed, WTContained, IdentityAccessControlled, Externalizable

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

Each WTChangeProposal instance is assigned a unique number which is generated by the system when the change proposal is stored in the database.

Use the newWTChangeProposal static factory method(s), not the WTChangeProposal 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:
wt.change2.WTChangeProposalIdentity, Serialized Form

Field Summary
static String DESCRIPTION
          Label for the attribute; An end-user provided statement to describe this WTChangeProposal.
static String NAME
          Label for the attribute; An end-user provided name for this WTChangeProposal.
static String NUMBER
          Label for the attribute; A unique number assigned to this WTChangeProposal when it is first stored in database.
 
Fields inherited from class wt.change2.VersionableChangeItem
MASTER
 
Fields inherited from interface wt.vc.Iterated
CONTROL_BRANCH, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_NOTE, LATEST_ITERATION, MASTER, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME
 
Fields inherited from interface wt.org.OrganizationOwnedVersion
MASTER_REFERENCE
 
Fields inherited from interface wt.org.OrganizationOwned
ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER
 
Method Summary
 String getDescription()
          Gets the value of the attribute: DESCRIPTION.
 String getName()
          Gets the value of the attribute: NAME.
 String getNumber()
          Gets the value of the attribute: NUMBER.
protected  void initialize(String name)
          Supports initialization, following construction of an instance.
static WTChangeProposal newWTChangeProposal()
          A no-arg new-factory method to construct an initialized instance of a WTChangeProposal.
static WTChangeProposal newWTChangeProposal(String name)
          A new-factory method that construct an initialized instance of a WTChangeProposal with the given name.
 void setDescription(String a_Description)
          Sets the value of the attribute: DESCRIPTION.
 void setName(String a_Name)
          Sets the value of the attribute: NAME.
 void setNumber(String a_Number)
          Sets the value of the attribute: NUMBER.
 
Methods inherited from class wt.change2.VersionableChangeItem
getControlBranch, getIterationIdentifier, getIterationNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, getOrganization, getOrganizationCodingSystem, getOrganizationName, getOrganizationUniqueIdentifier, isLatestIteration, setControlBranch, setMaster, setMasterReference, setOrganization
 
Methods inherited from class wt.fc.WTObject
getDisplayIdentifier, getDisplayIdentity, getDisplayType
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface wt.vc.Iterated
getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, setMaster, setMasterReference
 

Field Detail

NUMBER

public static final String NUMBER
Label for the attribute; A unique number assigned to this WTChangeProposal when it is first stored in database.

Supported API: true

See Also:
wt.change2.WTChangeProposalIdentity, Constant Field Values

NAME

public static final String NAME
Label for the attribute; An end-user provided name for this WTChangeProposal.

Supported API: true

See Also:
wt.change2.WTChangeProposalIdentity, Constant Field Values

DESCRIPTION

public static final String DESCRIPTION
Label for the attribute; An end-user provided statement to describe this WTChangeProposal.

Supported API: true

See Also:
Constant Field Values
Method Detail

getNumber

public String getNumber()
Gets the value of the attribute: NUMBER. A unique number assigned to this WTChangeProposal when it is first stored in database.

Supported API: true

Returns:
String
See Also:
wt.change2.WTChangeProposalIdentity

setNumber

public void setNumber(String a_Number)
               throws WTPropertyVetoException
Sets the value of the attribute: NUMBER. A unique number assigned to this WTChangeProposal when it is first stored in database.

Supported API: true

Parameters:
a_Number -
Throws:
WTPropertyVetoException
See Also:
wt.change2.WTChangeProposalIdentity

getName

public String getName()
Gets the value of the attribute: NAME. An end-user provided name for this WTChangeProposal.

Supported API: true

Returns:
String
See Also:
wt.change2.WTChangeProposalIdentity

setName

public void setName(String a_Name)
             throws WTPropertyVetoException
Sets the value of the attribute: NAME. An end-user provided name for this WTChangeProposal.

Supported API: true

Parameters:
a_Name -
Throws:
WTPropertyVetoException
See Also:
wt.change2.WTChangeProposalIdentity

getDescription

public String getDescription()
Gets the value of the attribute: DESCRIPTION. An end-user provided statement to describe this WTChangeProposal.

Supported API: true

Returns:
String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException
Sets the value of the attribute: DESCRIPTION. An end-user provided statement to describe this WTChangeProposal.

Supported API: true

Parameters:
a_Description -
Throws:
WTPropertyVetoException

newWTChangeProposal

public static WTChangeProposal newWTChangeProposal()
                                            throws WTException
A no-arg new-factory method to construct an initialized instance of a WTChangeProposal.

Supported API: true

Returns:
WTChangeProposal
Throws:
WTException

newWTChangeProposal

public static WTChangeProposal newWTChangeProposal(String name)
                                            throws WTException
A new-factory method that construct an initialized instance of a WTChangeProposal with the given name.

Supported API: true

Parameters:
name -
Returns:
WTChangeProposal
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