wt.effectivity
Class ConfigurationItem

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Managed
          wt.effectivity.ConfigurationItem

All Implemented Interfaces:

AccessControlled, AccessControlList, AdHocControlled, BusinessInformation, CabinetBased, DisplayIdentification, DomainAdministered, EffConfigurationItem, EffContext, Externalizable, Foldered, FolderEntry, FolderServiceManaged, Identified, Indexable, LifeCycleManaged, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, Serializable, SubjectOfForum, SubjectOfNotebook, TeamManaged, UniquelyIdentified

public class ConfigurationItem

extends Managed

implements EffConfigurationItem, Externalizable

This is a product that is planned for manufacture with various EffectivityManageables having Effectivitys under which specific versions are used to manufacture the product.

The product that is planned for manufacture is usually visible to a customer of the organization that does the configuration management. A ConfigurationItem can be an entire product concept or some portion of a product concept. ConfigurationItem is defined in PDM Enablers specification, section 2.8.3.1. This description was taken, in part, from the PDM Enablers specification.

Use the newConfigurationItem static factory method(s), not the ConfigurationItem 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:

ConfigurationItemReference, Serialized Form

Field Summary

private static String	CLASSNAME
private String	description
static String	DESCRIPTION Label for the attribute; A description of the Configuration Item.
private static int	DESCRIPTION_UPPER_LIMIT
static String	EFFECTIVITY_TYPE Label for the attribute.
private static int	EFFECTIVITY_TYPE_UPPER_LIMIT
private EffectivityType	effectivityType
static long	EXTERNALIZATION_VERSION_UID
private String	name
static String	NAME Label for the attribute; The name of the Configuration Item.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SOLUTION Label for the attribute; The solution for this EffConfigurationItem.
private ObjectReference	solutionReference

Fields inherited from class wt.enterprise.Managed

CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.eff.EffConfigurationItem

SOLUTION_REFERENCE

Fields inherited from interface wt.eff.EffContext

IDENTIFICATION_OBJECT

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

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.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

ConfigurationItem()

Method Summary

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	getConceptualClassname() Deprecated.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
EffectivityType	getEffectivityType() Gets the object for the association that plays role: EFFECTIVITY_TYPE.
IdentificationObject	getIdentificationObject() Gets the value of the attribute: IDENTIFICATION_OBJECT.
String	getIdentity() Gets the value of the attribute: IDENTITY.
String	getName() Gets the value of the attribute: NAME.
ProductSolution	getSolution() Gets the object for the association that plays role: SOLUTION.
ObjectReference	getSolutionReference() Gets the value of the attribute: SOLUTION_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name, String description) Supports initialization, following construction of an instance.
protected void	initialize(String name, String description, EffectivityType effectivityType) Supports initialization, following construction of an instance.
private void	nameValidate(String a_Name)
static ConfigurationItem	newConfigurationItem()
static ConfigurationItem	newConfigurationItem(String name, String description) Supported API: false
static ConfigurationItem	newConfigurationItem(String name, String description, EffectivityType effectivityType) 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(ConfigurationItem thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setEffectivityType(EffectivityType a_EffectivityType) Sets the object for the association that plays role: EFFECTIVITY_TYPE.
void	setIdentificationObject(IdentificationObject a_IdentificationObject) Sets the value of the attribute: IDENTIFICATION_OBJECT.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setSolution(ProductSolution a_Solution) Sets the object for the association that plays role: SOLUTION.
void	setSolutionReference(ObjectReference a_SolutionReference) Sets the value of the attribute: SOLUTION_REFERENCE.
private void	solutionReferenceValidate(ObjectReference a_SolutionReference)
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.enterprise.Managed

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

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, 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

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

NAME

public static final String NAME

Label for the attribute; The name of the Configuration Item.

Supported API: false

See Also:

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; A description of the Configuration Item.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

EFFECTIVITY_TYPE

public static final String EFFECTIVITY_TYPE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

EFFECTIVITY_TYPE_UPPER_LIMIT

private static int EFFECTIVITY_TYPE_UPPER_LIMIT

effectivityType

private EffectivityType effectivityType

SOLUTION

public static final String SOLUTION

Label for the attribute; The solution for this EffConfigurationItem.

Supported API: true

See Also:

Constant Field Values

solutionReference

private ObjectReference solutionReference

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

ConfigurationItem

public ConfigurationItem()

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 Managed

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 Managed

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ConfigurationItem 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 Managed

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 Managed

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

getName

public String getName()

Gets the value of the attribute: NAME. The name of the Configuration Item.

Supported API: false

Specified by:

getName in interface EffConfigurationItem

Overrides:

getName in class Managed

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. The name of the Configuration Item.

Supported API: false

Specified by:

setName in interface EffConfigurationItem

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. A description of the Configuration Item.

Supported API: false

Specified by:

getDescription in interface EffConfigurationItem

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. A description of the Configuration Item.

Supported API: false

Specified by:

setDescription in interface EffConfigurationItem

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getEffectivityType

public EffectivityType getEffectivityType()

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

Supported API: false

Returns:

EffectivityType

setEffectivityType

public void setEffectivityType(EffectivityType a_EffectivityType)
                        throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_EffectivityType -

Throws:

WTPropertyVetoException

newConfigurationItem

public static ConfigurationItem newConfigurationItem(String name,
                                                     String description,
                                                     EffectivityType effectivityType)
                                              throws WTException

Supported API: false

Parameters:

name -

description -

effectivityType -

Returns:

ConfigurationItem

Throws:

WTException

initialize

protected void initialize(String name,
                          String description,
                          EffectivityType effectivityType)
                   throws WTException

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

Supported API: false

Parameters:

name -

description -

effectivityType -

Throws:

WTException

newConfigurationItem

public static ConfigurationItem newConfigurationItem(String name,
                                                     String description)
                                              throws WTException

Supported API: false

Parameters:

name -

description -

Returns:

ConfigurationItem

Throws:

WTException

initialize

protected void initialize(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:

name -

description -

Throws:

WTException

getSolution

public ProductSolution getSolution()

Gets the object for the association that plays role: SOLUTION. The solution for this EffConfigurationItem.

Supported API: true

Specified by:

getSolution in interface EffConfigurationItem

Returns:

ProductSolution

setSolution

public void setSolution(ProductSolution a_Solution)
                 throws WTPropertyVetoException,
                        WTException

Sets the object for the association that plays role: SOLUTION. The solution for this EffConfigurationItem.

Supported API: true

Specified by:

setSolution in interface EffConfigurationItem

Parameters:

a_Solution -

Throws:

WTPropertyVetoException

WTException

getSolutionReference

public ObjectReference getSolutionReference()

Gets the value of the attribute: SOLUTION_REFERENCE. The solution for this EffConfigurationItem.

Supported API: true

Specified by:

getSolutionReference in interface EffConfigurationItem

Returns:

ObjectReference

setSolutionReference

public void setSolutionReference(ObjectReference a_SolutionReference)
                          throws WTPropertyVetoException

Sets the value of the attribute: SOLUTION_REFERENCE. The solution for this EffConfigurationItem.

Supported API: true

Specified by:

setSolutionReference in interface EffConfigurationItem

Parameters:

a_SolutionReference -

Throws:

WTPropertyVetoException

solutionReferenceValidate

private void solutionReferenceValidate(ObjectReference a_SolutionReference)
                                throws WTPropertyVetoException

Parameters:

a_SolutionReference -

Throws:

WTPropertyVetoException

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Gets the value of the attribute: IDENTIFICATION_OBJECT. This API must be completed by implementing classes.

The getter method should be implemented to return an IdentificationObject for use by UniquelyIdentified.

The setter method should be implemented to set the IdentificationObject back to the instance.

Supported API: false

Specified by:

getIdentificationObject in interface EffContext

Returns:

IdentificationObject

Throws:

WTException

See Also:

UniquelyIdentified, IdentificationObject

setIdentificationObject

public void setIdentificationObject(IdentificationObject a_IdentificationObject)
                             throws WTException

Sets the value of the attribute: IDENTIFICATION_OBJECT. This API must be completed by implementing classes.

The getter method should be implemented to return an IdentificationObject for use by UniquelyIdentified.

The setter method should be implemented to set the IdentificationObject back to the instance.

Supported API: false

Specified by:

setIdentificationObject in interface EffContext

Parameters:

a_IdentificationObject -

Throws:

WTException

See Also:

UniquelyIdentified, IdentificationObject

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 Managed

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 Managed

Returns:

int

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 Managed

Returns:

String

newConfigurationItem

public static ConfigurationItem newConfigurationItem()
                                              throws WTException

Throws:

WTException