wt.eff
Interface EffContext

All Superinterfaces:
Identified, NetFactor, ObjectMappable, Persistable, Serializable, UniquelyIdentified
All Known Subinterfaces:
EffConfigurationItem, ProductInstance
All Known Implementing Classes:
ConfigurationItem, WTProductInstance, WTProductMaster

public interface EffContext
extends Persistable, UniquelyIdentified

The context (ProductInstance or EffConfigurationItem) under which an Eff operates, the EffContext may be a configuration item, as recognized by PDM Enablers, for example.

The EffContext is uniquely identified to prevent name collisions between multiple implementating classes.

Supported API: true

Extendable: true


Field Summary
static String IDENTIFICATION_OBJECT
          Label for the attribute; This API must be completed by implementing classes.
 
Fields inherited from interface wt.fc.Persistable
IDENTITY, PERSIST_INFO, TYPE
 
Method Summary
 IdentificationObject getIdentificationObject()
          Gets the value of the attribute: IDENTIFICATION_OBJECT.
 void setIdentificationObject(IdentificationObject a_IdentificationObject)
          Sets the value of the attribute: IDENTIFICATION_OBJECT.
 
Methods inherited from interface wt.fc.Persistable
checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo
 
Methods inherited from interface wt.fc.ObjectMappable
readExternal, writeExternal
 
Methods inherited from interface wt.fc.NetFactor
getClassInfo, getConceptualClassname
 

Field Detail

IDENTIFICATION_OBJECT

public static final String IDENTIFICATION_OBJECT
Label for the attribute; 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

See Also:
UniquelyIdentified, IdentificationObject, Constant Field Values
Method Detail

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 Identified
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

Parameters:
a_IdentificationObject -
Throws:
WTException
See Also:
UniquelyIdentified, IdentificationObject