wt.eff
Interface EffConfigurationItem

All Superinterfaces:
EffContext, Identified, NetFactor, ObjectMappable, Persistable, Serializable, UniquelyIdentified
All Known Implementing Classes:
ConfigurationItem

public interface EffConfigurationItem
extends EffContext

A configuration item that serves as the context for which an Eff is valid. The solution/instance aspects have been deprecated; the configuration item reverts to its original role as simply a context for effectivities. The configuration aspect of the configuration item has been replaced by BaselineConfigurationVersion, with WTProductConfiguration as a Windchill implementation. Note that WTPartMaster is the context for effectivities.

Supported API: true

Extendable: true


Field Summary
static String DESCRIPTION
          Label for the attribute; A description of the configuration item.
static String NAME
          Label for the attribute; The name of the configuration item.
static String SOLUTION
          Label for the attribute; The solution for this EffConfigurationItem.
static String SOLUTION_REFERENCE
          Label for the attribute; The solution for this EffConfigurationItem.
 
Method Summary
 String getDescription()
          Gets the value of the attribute: DESCRIPTION.
 String getName()
          Gets the value of the attribute: NAME.
 wt.eff.ProductSolution getSolution()
          Gets the object for the association that plays role: SOLUTION.
 ObjectReference getSolutionReference()
          Gets the value of the attribute: SOLUTION_REFERENCE.
 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 setSolution(wt.eff.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.
 

Field Detail

NAME

static final String NAME
Label for the attribute; The name of the configuration item. It is required and must be unique across all implementations of this class.

Supported API: true

See Also:
Constant Field Values

DESCRIPTION

static final String DESCRIPTION
Label for the attribute; A description of the configuration item.

Supported API: true

See Also:
Constant Field Values

SOLUTION

static final String SOLUTION
Label for the attribute; The solution for this EffConfigurationItem.

Supported API: true

See Also:
Constant Field Values

SOLUTION_REFERENCE

static final String SOLUTION_REFERENCE
Label for the attribute; The solution for this EffConfigurationItem.

Supported API: true

See Also:
Constant Field Values
Method Detail

getName

String getName()
Gets the value of the attribute: NAME. The name of the configuration item. It is required and must be unique across all implementations of this class.

Supported API: true

Returns:
String

setName

void setName(String a_Name)
             throws WTPropertyVetoException
Sets the value of the attribute: NAME. The name of the configuration item. It is required and must be unique across all implementations of this class.

Supported API: true

Parameters:
a_Name -
Throws:
WTPropertyVetoException

getDescription

String getDescription()
Gets the value of the attribute: DESCRIPTION. A description of the configuration item.

Supported API: true

Returns:
String

setDescription

void setDescription(String a_Description)
                    throws WTPropertyVetoException
Sets the value of the attribute: DESCRIPTION. A description of the configuration item.

Supported API: true

Parameters:
a_Description -
Throws:
WTPropertyVetoException

getSolution

wt.eff.ProductSolution getSolution()
Gets the object for the association that plays role: SOLUTION. The solution for this EffConfigurationItem.

Supported API: true

Returns:
ProductSolution

setSolution

void setSolution(wt.eff.ProductSolution a_Solution)
                 throws WTPropertyVetoException,
                        WTException
Sets the object for the association that plays role: SOLUTION. The solution for this EffConfigurationItem.

Supported API: true

Parameters:
a_Solution -
Throws:
WTPropertyVetoException
WTException

getSolutionReference

ObjectReference getSolutionReference()
Gets the value of the attribute: SOLUTION_REFERENCE. The solution for this EffConfigurationItem.

Supported API: true

Returns:
ObjectReference

setSolutionReference

void setSolutionReference(ObjectReference a_SolutionReference)
                          throws WTPropertyVetoException
Sets the value of the attribute: SOLUTION_REFERENCE. The solution for this EffConfigurationItem.

Supported API: true

Parameters:
a_SolutionReference -
Throws:
WTPropertyVetoException