wt.part
Class WTProductConfiguration

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

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.AccessControlList, wt.access.AdHocControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, BaselineConfigurationVersion, Configuration, SerialNumberedBaselineConfigurationVersion, NetFactor, ObjectMappable, Persistable, DisplayIdentification, Indexable, WTContained, IteratedLifeCycleManaged, wt.lifecycle.LifeCycleManaged, Lockable, Notifiable, PathOccurrenceContext, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, wt.recent.RecentlyVisited, wt.team.TeamManaged, AdHocStringVersioned, Baseline, IteratedPartialBaseline, Iterated, SessionEditedIteration, Versionable, ViewManageable, wt.viewmarkup.Viewable, wt.workflow.notebook.IteratedSubjectOfNotebook, wt.workflow.notebook.SubjectOfNotebook

public class WTProductConfiguration
extends WTObject
implements SerialNumberedBaselineConfigurationVersion, ViewManageable, Indexable, IteratedLifeCycleManaged, Notifiable, SessionEditedIteration, wt.org.electronicIdentity.ElectronicallySignable, AdHocStringVersioned, WTContained, wt.viewmarkup.Viewable, OrganizationOwned, wt.admin.DomainAdministered, wt.workflow.notebook.IteratedSubjectOfNotebook, 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

static String	MASTER Label for the attribute.
static String	MASTER_REFERENCE Label for the attribute.
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.

Fields inherited from interface wt.configuration.BaselineConfigurationVersion

DESCRIPTION

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.org.OrganizationOwned

ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Method Summary

String	getAdHocStringIdentifier() Gets the value of the attribute: AD_HOC_STRING_IDENTIFIER.
wt.vc.ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
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.
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: ITERATION_IDENTIFIER.
String	getIterationNote() Gets the value of the attribute: ITERATION_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.
boolean	isLatestIteration() Gets the value of the attribute: LATEST_ITERATION.
void	setAdHocStringIdentifier(String a_AdHocStringIdentifier) Sets the value of the attribute: AD_HOC_STRING_IDENTIFIER.
void	setControlBranch(wt.vc.ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
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.

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

Field Detail

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

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

Method Detail

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

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

Specified by:

getMaster in interface Iterated

Returns:

Mastered

See Also:

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

Specified by:

setMaster in interface Iterated

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

getMasterReference

public ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE.

Supported API: true

Specified by:

getMasterReference in interface BaselineConfigurationVersion

Specified by:

getMasterReference in interface Iterated

Returns:

ObjectReference

See Also:

Mastered

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

Specified by:

setMasterReference in interface Iterated

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

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

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

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

getControlBranch

public wt.vc.ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH. Derived attribute for displaying the Control Branch in query results.

Supported API: true

Specified by:

getControlBranch in interface Iterated

Returns:

ControlBranch

setControlBranch

public void setControlBranch(wt.vc.ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH. Derived attribute for displaying the Control Branch in query results.

Supported API: true

Specified by:

setControlBranch in interface Iterated

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

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

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

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

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

setOrganization

public void setOrganization(WTOrganization a_Organization)
                     throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION.

Supported API: true

Parameters:

a_Organization -

Throws:

WTPropertyVetoException