wt.part
Class WTProductConfiguration

java.lang.Object
  wt.fc.WTObject
      wt.part.WTProductConfiguration

All Implemented Interfaces:

AccessControlled, AccessControlList, AdHocControlled, AdHocStringVersioned, Baseline, BaselineConfigurationVersion, Configuration, DisplayIdentification, DomainAdministered, ElectronicallySignable, Externalizable, Indexable, Iterated, IteratedLifeCycleManaged, IteratedPartialBaseline, LifeCycleManaged, Lockable, NetFactor, Notifiable, ObjectMappable, OrganizationOwned, PathOccurrenceContext, Persistable, RecentlyVisited, Serializable, SerialNumberedBaselineConfigurationVersion, SessionEditedIteration, SubjectOfNotebook, TeamManaged, Versionable, Viewable, ViewManageable, WTContained

public class WTProductConfiguration

extends WTObject

implements SerialNumberedBaselineConfigurationVersion, ViewManageable, Indexable, IteratedLifeCycleManaged, AccessControlled, Notifiable, DomainAdministered, SessionEditedIteration, ElectronicallySignable, AdHocStringVersioned, WTContained, Viewable, OrganizationOwned, SubjectOfNotebook, Externalizable

Use the newWTProductConfiguration static factory method(s), not the WTProductConfiguration 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 int	AD_HOC_STRING_IDENTIFIER_UPPER_LIMIT
private String	adHocStringIdentifier
private static String	CLASSNAME
static String	CONFIGURATION_NAME Label for the attribute.
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
private ControlBranch	controlBranch
private String	description
private static int	DESCRIPTION_UPPER_LIMIT
private AdminDomainRef	domainRef
private AclEntrySet	entrySet
private WTStringSet	eventSet
static long	EXTERNALIZATION_VERSION_UID
private IndexerSet	indexerSet
private boolean	inheritedDomain
private IterationInfo	iterationInfo
private Lock	lock
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	ORGANIZATION Label for the attribute; The organization attribute represents the organization for the product.
static String	ORGANIZATION_REFERENCE Label for the attribute; The organizationReference attribute represents the reference to organization for the product.
static String	PRODUCT_DEFAULT_UNIT Label for the attribute; The name of the part -- the name a part is commonly refered to by, such as "piston".
static String	PRODUCT_NAME Label for the attribute; The name of the part -- the name a part is commonly refered to by, such as "piston".
static String	PRODUCT_NUMBER Label for the attribute; The number attribute represents the number for this part and all of its versions.
static long	R60_EXTERNALIZATION_VERSION_UID
static long	R62_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private WTPrincipalReference	sessionOwner
private LifeCycleState	state
private TeamReference	teamId
private TeamTemplateReference	teamTemplateId
private ViewReference	view

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.configuration.BaselineConfigurationVersion

DESCRIPTION

Fields inherited from interface wt.locks.Lockable

LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.vc.views.ViewManageable

VIEW, VIEW_NAME

Fields inherited from interface wt.index.Indexable

INDEXER_SET

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.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.vc.sessioniteration.SessionEditedIteration

SESSION_OWNER

Fields inherited from interface wt.vc.AdHocStringVersioned

AD_HOC_STRING_IDENTIFIER

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WTProductConfiguration()

Method Summary

private void	adHocStringIdentifierValidate(String a_AdHocStringIdentifier)
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	getAdHocStringIdentifier() Gets the value of the attribute: AD_HOC_STRING_IDENTIFIER.
long	getBranchIdentifier() Gets the value of the attribute: BRANCH_IDENTIFIER.
String	getConceptualClassname() Deprecated.
String	getConfigurationName() Gets the value of the attribute: CONFIGURATION_NAME.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
WTPrincipalReference	getCreator() Gets the value of the attribute: CREATOR.
String	getCreatorEMail() Gets the value of the attribute: CREATOR_EMAIL.
String	getCreatorFullName() Gets the value of the attribute: CREATOR_FULL_NAME.
String	getCreatorName() Gets the value of the attribute: CREATOR_NAME.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
AdminDomainRef	getDomainRef() Gets the object for the association that plays role: DOMAIN_REF.
AclEntrySet	getEntrySet() Gets the value of the attribute: ENTRY_SET.
WTStringSet	getEventSet() Gets the value of the attribute: EVENT_SET.
String	getIdentity() Gets the value of the attribute: IDENTITY.
IndexerSet	getIndexerSet() Gets the value of the attribute: INDEXER_SET.
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: ITERATION_IDENTIFIER.
IterationInfo	getIterationInfo() Gets the object for the association that plays role: ITERATION_INFO.
String	getIterationNote() Gets the value of the attribute: ITERATION_NOTE.
String	getLifeCycleName() Gets the value of the attribute: LIFE_CYCLE_NAME.
State	getLifeCycleState() Gets the value of the attribute: LIFE_CYCLE_STATE.
LifeCycleTemplateReference	getLifeCycleTemplate() Gets the value of the attribute: LIFE_CYCLE_TEMPLATE.
Lock	getLock() Gets the object for the association that plays role: LOCK.
Timestamp	getLockDate() Gets the value of the attribute: LOCK_DATE.
WTPrincipalReference	getLocker() Gets the value of the attribute: LOCKER.
String	getLockerEMail() Gets the value of the attribute: LOCKER_EMAIL.
String	getLockerFullName() Gets the value of the attribute: LOCKER_FULL_NAME.
String	getLockerName() Gets the value of the attribute: LOCKER_NAME.
String	getLockNote() Gets the value of the attribute: LOCK_NOTE.
Mastered	getMaster() Gets the object for the association that plays role: MASTER.
ObjectReference	getMasterReference() Gets the value of the attribute: MASTER_REFERENCE.
WTPrincipalReference	getModifier() Gets the value of the attribute: MODIFIER.
String	getModifierEMail() Gets the value of the attribute: MODIFIER_EMAIL.
String	getModifierFullName() Gets the value of the attribute: MODIFIER_FULL_NAME.
String	getModifierName() Gets the value of the attribute: MODIFIER_NAME.
WTOrganization	getOrganization() Gets the value of the attribute: ORGANIZATION.
String	getOrganizationCodingSystem() Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM.
String	getOrganizationName() Gets the value of the attribute: ORGANIZATION_NAME.
WTPrincipalReference	getOrganizationReference() Gets the value of the attribute: ORGANIZATION_REFERENCE.
String	getOrganizationUniqueIdentifier() Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.
QuantityUnit	getProductDefaultUnit() Gets the value of the attribute: PRODUCT_DEFAULT_UNIT.
String	getProductName() Gets the value of the attribute: PRODUCT_NAME.
String	getProductNumber() Gets the value of the attribute: PRODUCT_NUMBER.
WTPrincipalReference	getSessionOwner() Gets the object for the association that plays role: SESSION_OWNER.
LifeCycleState	getState() Gets the object for the association that plays role: STATE.
TeamReference	getTeamId() Gets the object for the association that plays role: TEAM_ID.
String	getTeamIdentity() Gets the value of the attribute: TEAM_IDENTITY.
String	getTeamName() Gets the value of the attribute: TEAM_NAME.
TeamTemplateReference	getTeamTemplateId() Gets the object for the association that plays role: TEAM_TEMPLATE_ID.
String	getTeamTemplateIdentity() Gets the value of the attribute: TEAM_TEMPLATE_IDENTITY.
String	getTeamTemplateName() Gets the value of the attribute: TEAM_TEMPLATE_NAME.
ViewReference	getView() Gets the object for the association that plays role: VIEW.
String	getViewName() Gets the value of the attribute: VIEW_NAME.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(WTProductMaster configurationFor)
protected void	initialize(WTProductMaster configurationFor, String name, String description) Supports initialization, following construction of an instance.
boolean	isInheritedDomain() Gets the value of the attribute: INHERITED_DOMAIN.
boolean	isLatestIteration() Gets the value of the attribute: LATEST_ITERATION.
boolean	isLifeCycleAtGate() Gets the value of the attribute: LIFE_CYCLE_AT_GATE.
boolean	isLifeCycleBasic() Gets the value of the attribute: LIFE_CYCLE_BASIC.
boolean	isLocked() Gets the value of the attribute: LOCKED.
private void	iterationInfoValidate(IterationInfo a_IterationInfo)
private void	lockValidate(Lock a_Lock)
private void	masterReferenceValidate(ObjectReference a_MasterReference)
static WTProductConfiguration	newWTProductConfiguration(WTProductMaster configurationFor)
static WTProductConfiguration	newWTProductConfiguration(WTProductMaster configurationFor, String name, String description) 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(WTProductConfiguration thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
private void	sessionOwnerValidate(WTPrincipalReference a_SessionOwner)
void	setAdHocStringIdentifier(String a_AdHocStringIdentifier) Sets the value of the attribute: AD_HOC_STRING_IDENTIFIER.
void	setConfigurationName(String a_ConfigurationName) Sets the value of the attribute: CONFIGURATION_NAME.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setControlBranch(ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setDomainRef(AdminDomainRef a_DomainRef) Sets the object for the association that plays role: DOMAIN_REF.
void	setEntrySet(AclEntrySet a_EntrySet) Sets the value of the attribute: ENTRY_SET.
void	setEventSet(WTStringSet a_EventSet) Sets the value of the attribute: EVENT_SET.
void	setIndexerSet(IndexerSet a_IndexerSet) Sets the value of the attribute: INDEXER_SET.
void	setInheritedDomain(boolean a_InheritedDomain) Sets the value of the attribute: INHERITED_DOMAIN.
void	setIterationInfo(IterationInfo a_IterationInfo) Sets the object for the association that plays role: ITERATION_INFO.
void	setLock(Lock a_Lock) Sets the object for the association that plays role: LOCK.
void	setMaster(Mastered 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	setOrganization(WTOrganization a_Organization) Sets the value of the attribute: ORGANIZATION.
void	setOrganizationReference(WTPrincipalReference a_OrganizationReference) Sets the value of the attribute: ORGANIZATION_REFERENCE.
void	setSessionOwner(WTPrincipalReference a_SessionOwner) Sets the object for the association that plays role: SESSION_OWNER.
void	setState(LifeCycleState a_State) Sets the object for the association that plays role: STATE.
void	setTeamId(TeamReference a_TeamId) Sets the object for the association that plays role: TEAM_ID.
void	setTeamTemplateId(TeamTemplateReference a_TeamTemplateId) Sets the object for the association that plays role: TEAM_TEMPLATE_ID.
void	setView(ViewReference a_View) Sets the object for the association that plays role: VIEW.
private void	stateValidate(LifeCycleState a_State)
private void	teamIdValidate(TeamReference a_TeamId)
private void	teamTemplateIdValidate(TeamTemplateReference a_TeamTemplateId)
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.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

PRODUCT_NUMBER

public static final String PRODUCT_NUMBER

Label for the attribute; The number attribute represents the number for this part and all of its versions. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

See Also:

Constant Field Values

PRODUCT_NAME

public static final String PRODUCT_NAME

Label for the attribute; The name of the part -- the name a part is commonly refered to by, such as "piston".

Supported API: true

See Also:

Constant Field Values

PRODUCT_DEFAULT_UNIT

public static final String PRODUCT_DEFAULT_UNIT

Label for the attribute; The name of the part -- the name a part is commonly refered to by, such as "piston".

Supported API: true

See Also:

Constant Field Values

CONFIGURATION_NAME

public static final String CONFIGURATION_NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ORGANIZATION_REFERENCE

public static final String ORGANIZATION_REFERENCE

Label for the attribute; The organizationReference attribute represents the reference to organization for the product. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

See Also:

Constant Field Values

ORGANIZATION

public static final String ORGANIZATION

Label for the attribute; The organization attribute represents the organization for the product. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

See Also:

Constant Field Values

MASTER

public static final String MASTER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

MASTER_REFERENCE

public static final String MASTER_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

masterReference

private ObjectReference masterReference

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

lock

private Lock lock

controlBranch

private ControlBranch controlBranch

iterationInfo

private IterationInfo iterationInfo

view

private ViewReference view

indexerSet

private IndexerSet indexerSet

state

private LifeCycleState state

entrySet

private AclEntrySet entrySet

teamTemplateId

private TeamTemplateReference teamTemplateId

teamId

private TeamReference teamId

eventSet

private WTStringSet eventSet

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

sessionOwner

private WTPrincipalReference sessionOwner

AD_HOC_STRING_IDENTIFIER_UPPER_LIMIT

private static int AD_HOC_STRING_IDENTIFIER_UPPER_LIMIT

adHocStringIdentifier

private String adHocStringIdentifier

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

R60_EXTERNALIZATION_VERSION_UID

public static final long R60_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

R62_EXTERNALIZATION_VERSION_UID

public static final long R62_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

WTProductConfiguration

public WTProductConfiguration()

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 WTObject

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 WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTProductConfiguration 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 WTObject

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 WTObject

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

getProductNumber

public String getProductNumber()

Gets the value of the attribute: PRODUCT_NUMBER. The number attribute represents the number for this part and all of its versions. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

Returns:

String

getProductName

public String getProductName()

Gets the value of the attribute: PRODUCT_NAME. The name of the part -- the name a part is commonly refered to by, such as "piston".

Supported API: true

Returns:

String

getProductDefaultUnit

public QuantityUnit getProductDefaultUnit()

Gets the value of the attribute: PRODUCT_DEFAULT_UNIT. The name of the part -- the name a part is commonly refered to by, such as "piston".

Supported API: true

Returns:

QuantityUnit

getConfigurationName

public String getConfigurationName()

Gets the value of the attribute: CONFIGURATION_NAME.

Supported API: false

Returns:

String

setConfigurationName

public void setConfigurationName(String a_ConfigurationName)
                          throws WTPropertyVetoException

Sets the value of the attribute: CONFIGURATION_NAME.

Supported API: false

Parameters:

a_ConfigurationName -

Throws:

WTPropertyVetoException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE. The organizationReference attribute represents the reference to organization for the product. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

Specified by:

getOrganizationReference in interface OrganizationOwned

Returns:

WTPrincipalReference

getOrganization

public WTOrganization getOrganization()

Gets the value of the attribute: ORGANIZATION. The organization attribute represents the organization for the product. Conceptually on the WTPart, it is actually implemented on the master.

Supported API: true

Specified by:

getOrganization in interface OrganizationOwned

Returns:

WTOrganization

getMaster

public Mastered getMaster()

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

Supported API: true

Specified by:

getMaster in interface BaselineConfigurationVersion

Returns:

Mastered

setMaster

public void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: true

Specified by:

setMaster in interface BaselineConfigurationVersion

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

getMasterReference

public ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE.

Supported API: true

Specified by:

getMasterReference in interface BaselineConfigurationVersion

Returns:

ObjectReference

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: true

Specified by:

setMasterReference in interface BaselineConfigurationVersion

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

newWTProductConfiguration

public static WTProductConfiguration newWTProductConfiguration(WTProductMaster configurationFor,
                                                               String name,
                                                               String description)
                                                        throws WTException

Supported API: false

Parameters:

configurationFor -

name -

description -

Returns:

WTProductConfiguration

Throws:

WTException

initialize

protected void initialize(WTProductMaster configurationFor,
                          String name,
                          String description)
                   throws WTException

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

Supported API: false

Parameters:

configurationFor -

name -

description -

Throws:

WTException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. The description of this configuration.

Supported API: true

Specified by:

getDescription in interface BaselineConfigurationVersion

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. The description of this configuration.

Supported API: true

Specified by:

setDescription in interface BaselineConfigurationVersion

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

isLocked

public boolean isLocked()

Gets the value of the attribute: LOCKED. Derived attribute for displaying the isSeized value in query results.

Supported API: false

Specified by:

isLocked in interface Lockable

Returns:

boolean

getLockDate

public Timestamp getLockDate()

Gets the value of the attribute: LOCK_DATE. Derived attribute for displaying the lock date value in query results.

Supported API: false

Specified by:

getLockDate in interface Lockable

Returns:

Timestamp

getLockNote

public String getLockNote()

Gets the value of the attribute: LOCK_NOTE. Derived attribute for displaying the lock note value in query results.

Supported API: false

Specified by:

getLockNote in interface Lockable

Returns:

String

getLocker

public WTPrincipalReference getLocker()

Gets the value of the attribute: LOCKER. Derived attribute for querying for the locker.

Supported API: false

Specified by:

getLocker in interface Lockable

Returns:

WTPrincipalReference

getLockerEMail

public String getLockerEMail()

Gets the value of the attribute: LOCKER_EMAIL. Derived attribute for displaying the locker E-Mail value in query results.

Supported API: false

Specified by:

getLockerEMail in interface Lockable

Returns:

String

getLockerName

public String getLockerName()

Gets the value of the attribute: LOCKER_NAME. Derived attribute for displaying the locker name value in query results.

Supported API: false

Specified by:

getLockerName in interface Lockable

Returns:

String

getLockerFullName

public String getLockerFullName()

Gets the value of the attribute: LOCKER_FULL_NAME. Derived attribute for displaying the lock fullname value in query results.

Supported API: false

Specified by:

getLockerFullName in interface Lockable

Returns:

String

getLock

public Lock getLock()

Gets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

getLock in interface Lockable

Returns:

Lock

See Also:

Lock

setLock

public void setLock(Lock a_Lock)
             throws WTPropertyVetoException

Sets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Specified by:

setLock in interface Lockable

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

See Also:

Lock

lockValidate

private void lockValidate(Lock a_Lock)
                   throws WTPropertyVetoException

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

getIterationNote

public String getIterationNote()

Gets the value of the attribute: ITERATION_NOTE. Derived attribute for displaying the iteration's note in query results.

Supported API: true

Specified by:

getIterationNote in interface Iterated

Returns:

String

getCreatorEMail

public String getCreatorEMail()

Gets the value of the attribute: CREATOR_EMAIL. Derived attribute for displaying the iteration creator's E-Mail address in query results.

Supported API: true

Specified by:

getCreatorEMail in interface Iterated

Returns:

String

getCreatorName

public String getCreatorName()

Gets the value of the attribute: CREATOR_NAME. Derived attribute for displaying the iteration creator's name in query results.

Supported API: true

Specified by:

getCreatorName in interface Iterated

Returns:

String

getCreatorFullName

public String getCreatorFullName()

Gets the value of the attribute: CREATOR_FULL_NAME. Derived attribute for displaying the iteration creator's fullname in query results.

Supported API: true

Specified by:

getCreatorFullName in interface Iterated

Returns:

String

getModifier

public WTPrincipalReference getModifier()

Gets the value of the attribute: MODIFIER. Derived attribute for displaying the iteration's modifier in query results.

Supported API: true

Specified by:

getModifier in interface Iterated

Returns:

WTPrincipalReference

getModifierEMail

public String getModifierEMail()

Gets the value of the attribute: MODIFIER_EMAIL. Derived attribute for displaying the iteration modifier's E-Mail address in query results.

Supported API: true

Specified by:

getModifierEMail in interface Iterated

Returns:

String

getModifierName

public String getModifierName()

Gets the value of the attribute: MODIFIER_NAME. Derived attribute for displaying the iteration modifier's name in query results.

Supported API: true

Specified by:

getModifierName in interface Iterated

Returns:

String

getModifierFullName

public String getModifierFullName()

Gets the value of the attribute: MODIFIER_FULL_NAME. Derived attribute for displaying the iteration modifier's fullname in query results.

Supported API: true

Specified by:

getModifierFullName in interface Iterated

Returns:

String

getIterationIdentifier

public IterationIdentifier getIterationIdentifier()

Gets the value of the attribute: ITERATION_IDENTIFIER. Derived attribute for displaying the iteration identifier in query results.

Supported API: true

Specified by:

getIterationIdentifier in interface Iterated

Returns:

IterationIdentifier

getBranchIdentifier

public long getBranchIdentifier()

Gets the value of the attribute: BRANCH_IDENTIFIER. Derived attribute for displaying the iteration's branch identifier in query results.

Supported API: false

Specified by:

getBranchIdentifier in interface Iterated

Returns:

long

isLatestIteration

public boolean isLatestIteration()

Gets the value of the attribute: LATEST_ITERATION. Derived attribute for displaying the iteration "latest" flag in query results.

Supported API: true

Specified by:

isLatestIteration in interface Iterated

Returns:

boolean

getCreator

public WTPrincipalReference getCreator()

Gets the value of the attribute: CREATOR. Derived attribute for displaying the Version Creator. Will be the same for each iteration of a Version. A Version corresponds to all iterations for a given branchId

Supported API: false

Specified by:

getCreator in interface Iterated

Returns:

WTPrincipalReference

getControlBranch

public ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Specified by:

getControlBranch in interface Iterated

Returns:

ControlBranch

setControlBranch

public void setControlBranch(ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Specified by:

setControlBranch in interface Iterated

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

getIterationInfo

public IterationInfo getIterationInfo()

Gets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

getIterationInfo in interface Iterated

Returns:

IterationInfo

See Also:

IterationInfo

setIterationInfo

public void setIterationInfo(IterationInfo a_IterationInfo)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

setIterationInfo in interface Iterated

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

See Also:

IterationInfo

iterationInfoValidate

private void iterationInfoValidate(IterationInfo a_IterationInfo)
                            throws WTPropertyVetoException

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

getViewName

public String getViewName()

Gets the value of the attribute: VIEW_NAME. Derived attribute for displaying the view name value in query results.

Supported API: false

Specified by:

getViewName in interface ViewManageable

Returns:

String

getView

public ViewReference getView()

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

Supported API: false

Specified by:

getView in interface ViewManageable

Returns:

ViewReference

setView

public void setView(ViewReference a_View)

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

Supported API: false

Specified by:

setView in interface ViewManageable

Parameters:

a_View -

getIndexerSet

public IndexerSet getIndexerSet()

Gets the value of the attribute: INDEXER_SET.

Supported API: false

Specified by:

getIndexerSet in interface Indexable

Returns:

IndexerSet

setIndexerSet

public void setIndexerSet(IndexerSet a_IndexerSet)

Sets the value of the attribute: INDEXER_SET.

Supported API: false

Specified by:

setIndexerSet in interface Indexable

Parameters:

a_IndexerSet -

getLifeCycleName

public String getLifeCycleName()

Gets the value of the attribute: LIFE_CYCLE_NAME. the Name of the LifeCycle template (a derived attribute)

Supported API: false

Specified by:

getLifeCycleName in interface LifeCycleManaged

Returns:

String

getLifeCycleState

public State getLifeCycleState()

Gets the value of the attribute: LIFE_CYCLE_STATE. the current State of the LifeCycleManaged object (a derived attribute)

Supported API: false

Specified by:

getLifeCycleState in interface LifeCycleManaged

Returns:

State

isLifeCycleAtGate

public boolean isLifeCycleAtGate()

Gets the value of the attribute: LIFE_CYCLE_AT_GATE. the current AtGate flag on the LifeCycleManaged object (a derived attribute)

Supported API: false

Specified by:

isLifeCycleAtGate in interface LifeCycleManaged

Returns:

boolean

getLifeCycleTemplate

public LifeCycleTemplateReference getLifeCycleTemplate()

Gets the value of the attribute: LIFE_CYCLE_TEMPLATE. the LifeCycleTemplate of the LifeCycleManaged object (a derived attribute)

Supported API: false

Specified by:

getLifeCycleTemplate in interface LifeCycleManaged

Returns:

LifeCycleTemplateReference

isLifeCycleBasic

public boolean isLifeCycleBasic()

Gets the value of the attribute: LIFE_CYCLE_BASIC. This attribute is used to specify if the lifecycle template is basic (no roles, ad hoc access, workflows or criteria) or advanced (may contain roles, ad hoc access, access, workfow and criteria).

Supported API: false

Specified by:

isLifeCycleBasic in interface LifeCycleManaged

Returns:

boolean

getState

public LifeCycleState getState()

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

Supported API: false

Specified by:

getState in interface LifeCycleManaged

Returns:

LifeCycleState

setState

public void setState(LifeCycleState a_State)
              throws WTPropertyVetoException

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

Supported API: false

Specified by:

setState in interface LifeCycleManaged

Parameters:

a_State -

Throws:

WTPropertyVetoException

stateValidate

private void stateValidate(LifeCycleState a_State)
                    throws WTPropertyVetoException

Parameters:

a_State -

Throws:

WTPropertyVetoException

getEntrySet

public AclEntrySet getEntrySet()

Gets the value of the attribute: ENTRY_SET.

Supported API: false

Specified by:

getEntrySet in interface AdHocControlled

Returns:

AclEntrySet

setEntrySet

public void setEntrySet(AclEntrySet a_EntrySet)

Sets the value of the attribute: ENTRY_SET.

Supported API: false

Specified by:

setEntrySet in interface AdHocControlled

Parameters:

a_EntrySet -

getTeamName

public String getTeamName()

Gets the value of the attribute: TEAM_NAME. The name of the team(a derived attribute)

Supported API: false

Specified by:

getTeamName in interface TeamManaged

Returns:

String

getTeamIdentity

public String getTeamIdentity()

Gets the value of the attribute: TEAM_IDENTITY. The identity of the team (a derived attribute)

Supported API: false

Specified by:

getTeamIdentity in interface TeamManaged

Returns:

String

getTeamTemplateName

public String getTeamTemplateName()

Gets the value of the attribute: TEAM_TEMPLATE_NAME. The name of the teamTemplate(a derived attribute)

Supported API: false

Specified by:

getTeamTemplateName in interface TeamManaged

Returns:

String

getTeamTemplateIdentity

public String getTeamTemplateIdentity()

Gets the value of the attribute: TEAM_TEMPLATE_IDENTITY. The identity of the TeamTemplate (a derived attribute)

Supported API: false

Specified by:

getTeamTemplateIdentity in interface TeamManaged

Returns:

String

getTeamTemplateId

public TeamTemplateReference getTeamTemplateId()

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

Supported API: false

Specified by:

getTeamTemplateId in interface TeamManaged

Returns:

TeamTemplateReference

setTeamTemplateId

public void setTeamTemplateId(TeamTemplateReference a_TeamTemplateId)
                       throws WTPropertyVetoException

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

Supported API: false

Specified by:

setTeamTemplateId in interface TeamManaged

Parameters:

a_TeamTemplateId -

Throws:

WTPropertyVetoException

teamTemplateIdValidate

private void teamTemplateIdValidate(TeamTemplateReference a_TeamTemplateId)
                             throws WTPropertyVetoException

Parameters:

a_TeamTemplateId -

Throws:

WTPropertyVetoException

getTeamId

public TeamReference getTeamId()

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

Supported API: false

Specified by:

getTeamId in interface TeamManaged

Returns:

TeamReference

setTeamId

public void setTeamId(TeamReference a_TeamId)
               throws WTPropertyVetoException

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

Supported API: false

Specified by:

setTeamId in interface TeamManaged

Parameters:

a_TeamId -

Throws:

WTPropertyVetoException

teamIdValidate

private void teamIdValidate(TeamReference a_TeamId)
                     throws WTPropertyVetoException

Parameters:

a_TeamId -

Throws:

WTPropertyVetoException

getEventSet

public WTStringSet getEventSet()

Gets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

getEventSet in interface Notifiable

Returns:

WTStringSet

setEventSet

public void setEventSet(WTStringSet a_EventSet)

Sets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

setEventSet in interface Notifiable

Parameters:

a_EventSet -

isInheritedDomain

public boolean isInheritedDomain()

Gets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

isInheritedDomain in interface DomainAdministered

Returns:

boolean

setInheritedDomain

public void setInheritedDomain(boolean a_InheritedDomain)
                        throws WTPropertyVetoException

Sets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

setInheritedDomain in interface DomainAdministered

Parameters:

a_InheritedDomain -

Throws:

WTPropertyVetoException

getDomainRef

public AdminDomainRef getDomainRef()

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

Supported API: false

Specified by:

getDomainRef in interface DomainAdministered

Returns:

AdminDomainRef

setDomainRef

public void setDomainRef(AdminDomainRef a_DomainRef)

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

Supported API: false

Specified by:

setDomainRef in interface DomainAdministered

Parameters:

a_DomainRef -

getSessionOwner

public WTPrincipalReference getSessionOwner()

Gets the object for the association that plays role: SESSION_OWNER. The owner of the session iteration.

Supported API: true

Specified by:

getSessionOwner in interface SessionEditedIteration

Returns:

WTPrincipalReference

setSessionOwner

public void setSessionOwner(WTPrincipalReference a_SessionOwner)
                     throws WTPropertyVetoException

Sets the object for the association that plays role: SESSION_OWNER. The owner of the session iteration.

Supported API: true

Specified by:

setSessionOwner in interface SessionEditedIteration

Parameters:

a_SessionOwner -

Throws:

WTPropertyVetoException

sessionOwnerValidate

private void sessionOwnerValidate(WTPrincipalReference a_SessionOwner)
                           throws WTPropertyVetoException

Parameters:

a_SessionOwner -

Throws:

WTPropertyVetoException

getAdHocStringIdentifier

public String getAdHocStringIdentifier()

Gets the value of the attribute: AD_HOC_STRING_IDENTIFIER. This attribute persists the ad-hoc identifier provided by some client/process. This identifier is typically wrapped by another, more appropriately named attribute, such as "name".

Supported API: true

Specified by:

getAdHocStringIdentifier in interface AdHocStringVersioned

Returns:

String

setAdHocStringIdentifier

public void setAdHocStringIdentifier(String a_AdHocStringIdentifier)
                              throws WTPropertyVetoException

Sets the value of the attribute: AD_HOC_STRING_IDENTIFIER. This attribute persists the ad-hoc identifier provided by some client/process. This identifier is typically wrapped by another, more appropriately named attribute, such as "name".

Supported API: true

Specified by:

setAdHocStringIdentifier in interface AdHocStringVersioned

Parameters:

a_AdHocStringIdentifier -

Throws:

WTPropertyVetoException

adHocStringIdentifierValidate

private void adHocStringIdentifierValidate(String a_AdHocStringIdentifier)
                                    throws WTPropertyVetoException

Parameters:

a_AdHocStringIdentifier -

Throws:

WTPropertyVetoException

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

getOrganizationUniqueIdentifier

public String getOrganizationUniqueIdentifier()

Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER. The getter for this attribute delivers organization unique identifier.

Supported API: true

Specified by:

getOrganizationUniqueIdentifier in interface OrganizationOwned

Returns:

String

getOrganizationCodingSystem

public String getOrganizationCodingSystem()

Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM. The getter for this attribute delivers organization coding system.

Supported API: true

Specified by:

getOrganizationCodingSystem in interface OrganizationOwned

Returns:

String

getOrganizationName

public String getOrganizationName()

Gets the value of the attribute: ORGANIZATION_NAME. The getter for this attribute delivers organization name.

Supported API: true

Specified by:

getOrganizationName in interface OrganizationOwned

Returns:

String

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Specified by:

setOrganizationReference in interface OrganizationOwned

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

setOrganization

public void setOrganization(WTOrganization a_Organization)
                     throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION.

Supported API: true

Specified by:

setOrganization in interface OrganizationOwned

Parameters:

a_Organization -

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 WTObject

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 WTObject

Returns:

int

newWTProductConfiguration

public static WTProductConfiguration newWTProductConfiguration(WTProductMaster configurationFor)
                                                        throws WTException

Throws:

WTException

initialize

protected void initialize(WTProductMaster configurationFor)
                   throws WTException

Throws:

WTException

getIdentity

public String getIdentity()

Description copied from interface: Persistable

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

Overrides:

getIdentity in class WTObject

Returns:

String