wt.occurrence
Interface PathOccurrenceData

All Superinterfaces:
Iterated, NetFactor, ObjectMappable, OccurrenceData, Persistable, Serializable
All Known Implementing Classes:
BaselineConfigurationOverride, PathOccurrenceDocumentation, PathOccurrenceUserIBAs, SerialNumberMapping

public interface PathOccurrenceData
extends Iterated, OccurrenceData

This tagging interface is associated with a PathOccurrence largely to allow external applications to easily add application-specifc information in a relatively transparent and extensible manner. When deleting PathOccurrenceData you must call OccurrenceService.deletePathOccurrenceData(wt.occurrence.PathOccurrenceData) instead of the PersistenceManager.

Supported API: true

Extendable: true


Field Summary
static String CONTEXT
          Label for the attribute.
static String CONTEXT_REFERENCE
          Label for the attribute.
static String MASTER
          Label for the attribute.
static String MASTER_REFERENCE
          Label for the attribute.
static String OCC
          Label for the attribute.
static String OCC_REFERENCE
          Label for the attribute.
 
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.fc.Persistable
IDENTITY, PERSIST_INFO, TYPE
 
Method Summary
 PathOccurrenceContext getContext()
          Gets the object for the association that plays role: CONTEXT.
 ObjectReference getContextReference()
          Gets the value of the attribute: CONTEXT_REFERENCE.
 Mastered getMaster()
          Gets the object for the association that plays role: MASTER.
 ObjectReference getMasterReference()
          Gets the value of the attribute: MASTER_REFERENCE.
 PathOccurrence getOcc()
          Gets the object for the association that plays role: OCC.
 ObjectReference getOccReference()
          Gets the value of the attribute: OCC_REFERENCE.
 void setContext(PathOccurrenceContext a_Context)
          Sets the object for the association that plays role: CONTEXT.
 void setContextReference(ObjectReference a_ContextReference)
          Sets the value of the attribute: CONTEXT_REFERENCE.
 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 setOcc(PathOccurrence a_Occ)
          Sets the object for the association that plays role: OCC.
 void setOccReference(ObjectReference a_OccReference)
          Sets the value of the attribute: OCC_REFERENCE.
 
Methods inherited from interface wt.vc.Iterated
getBranchIdentifier, getControlBranch, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationInfo, getIterationNote, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, setIterationInfo
 
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

CONTEXT

public static final String CONTEXT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

CONTEXT_REFERENCE

public static final String CONTEXT_REFERENCE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

OCC

public static final String OCC
Label for the attribute.

Supported API: true

See Also:
Constant Field Values

OCC_REFERENCE

public static final String OCC_REFERENCE
Label for the attribute.

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

getContext

public PathOccurrenceContext getContext()
Gets the object for the association that plays role: CONTEXT.

Supported API: false

Returns:
PathOccurrenceContext

setContext

public void setContext(PathOccurrenceContext a_Context)
                throws WTPropertyVetoException,
                       WTException
Sets the object for the association that plays role: CONTEXT.

Supported API: false

Parameters:
a_Context -
Throws:
WTPropertyVetoException
WTException

getContextReference

public ObjectReference getContextReference()
Gets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Returns:
ObjectReference

setContextReference

public void setContextReference(ObjectReference a_ContextReference)
                         throws WTPropertyVetoException
Sets the value of the attribute: CONTEXT_REFERENCE.

Supported API: false

Parameters:
a_ContextReference -
Throws:
WTPropertyVetoException

getOcc

public PathOccurrence getOcc()
Gets the object for the association that plays role: OCC.

Supported API: true

Returns:
PathOccurrence

setOcc

public void setOcc(PathOccurrence a_Occ)
            throws WTPropertyVetoException,
                   WTException
Sets the object for the association that plays role: OCC.

Supported API: true

Parameters:
a_Occ -
Throws:
WTPropertyVetoException
WTException

getOccReference

public ObjectReference getOccReference()
Gets the value of the attribute: OCC_REFERENCE.

Supported API: true

Returns:
ObjectReference

setOccReference

public void setOccReference(ObjectReference a_OccReference)
                     throws WTPropertyVetoException
Sets the value of the attribute: OCC_REFERENCE.

Supported API: true

Parameters:
a_OccReference -
Throws:
WTPropertyVetoException

getMaster

public Mastered getMaster()
Gets the object for the association that plays role: MASTER.

Supported API: true

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 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 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 Iterated
Parameters:
a_MasterReference -
Throws:
WTPropertyVetoException
See Also:
Mastered