wt.occurrence
Interface PathOccurrence

All Superinterfaces:

NetFactor, ObjectMappable, Occurrence, PathParentableOccurrence, Persistable, Serializable

All Known Implementing Classes:

PartPathOccurrence

public interface PathOccurrence

extends Occurrence, Persistable, PathParentableOccurrence

This Occurrence identifies a unique path of UsesOccurrence objects, in order to deal with:

• the ambiguity inherent when any of the OccurrenceableLink objects have quantity greater than 1
• the need to hang PathOccurrenceData off of the path of links

.

Supported API: true

Extendable: true

Field Summary

static String	COMBINED_PATH_OCCURRENCE_VECTOR Label for the attribute; This Vector can be populated with CombinedPathOccurrence that is associated to a parent PathOccurrence.
static String	CONTEXT Label for the attribute.
static String	CONTEXT_REFERENCE Label for the attribute.
static String	PATH_NAME Label for the attribute.
static String	SUB_PATH Label for the attribute.
static String	SUB_PATH_REFERENCE Label for the attribute.
static String	USES Label for the attribute; This non-persistent value stores the UsesOccurrence that was used to retrieve the PathOccurrence.
static String	USES_NAME Label for the attribute.
static String	USES_REFERENCE Label for the attribute.

Fields inherited from interface wt.occurrence.Occurrence

NAME, OCCURRENCE_DATA_VECTOR

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

Vector	getCombinedPathOccurrenceVector() Gets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR.
PathOccurrenceMasterContext	getContext() Gets the object for the association that plays role: CONTEXT.
ObjectReference	getContextReference() Gets the value of the attribute: CONTEXT_REFERENCE.
Vector	getPathList() Returns a Vector of the PathOccurrence objects that make up this path.
String	getPathName() Gets the value of the attribute: PATH_NAME.
PathOccurrence	getSubPath() Gets the object for the association that plays role: SUB_PATH.
ObjectReference	getSubPathReference() Gets the value of the attribute: SUB_PATH_REFERENCE.
UsesOccurrence	getUses() Gets the value of the attribute: USES.
String	getUsesName() Gets the value of the attribute: USES_NAME.
UsesOccurrenceReference	getUsesReference() Gets the object for the association that plays role: USES_REFERENCE.
boolean	hasSubPath() Returns true if the PathOccurrence has a non-null sub path.
void	setCombinedPathOccurrenceVector(Vector a_CombinedPathOccurrenceVector) Sets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR.
void	setContext(PathOccurrenceMasterContext 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	setPathName(String a_PathName) Sets the value of the attribute: PATH_NAME.
void	setSubPath(PathOccurrence a_SubPath) Sets the object for the association that plays role: SUB_PATH.
void	setSubPathReference(ObjectReference a_SubPathReference) Sets the value of the attribute: SUB_PATH_REFERENCE.
void	setUses(UsesOccurrence a_Uses) Sets the value of the attribute: USES.
void	setUsesName(String a_UsesName) Sets the value of the attribute: USES_NAME.
void	setUsesReference(UsesOccurrenceReference a_UsesReference) Sets the object for the association that plays role: USES_REFERENCE.

Methods inherited from interface wt.occurrence.Occurrence

getName, getOccurrenceDataVector, setName, setOccurrenceDataVector

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

COMBINED_PATH_OCCURRENCE_VECTOR

public static final String COMBINED_PATH_OCCURRENCE_VECTOR

Label for the attribute; This Vector can be populated with CombinedPathOccurrence that is associated to a parent PathOccurrence.

Supported API: true

See Also:

Constant Field Values

USES

public static final String USES

Label for the attribute; This non-persistent value stores the UsesOccurrence that was used to retrieve the PathOccurrence. This is necessary since the PathOccurrence only has a UsesOccurrenceReference, which could refer to more than one UsesOccurrence.

Supported API: true

See Also:

Constant Field Values

USES_NAME

public static final String USES_NAME

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

PATH_NAME

public static final String PATH_NAME

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

SUB_PATH

public static final String SUB_PATH

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

SUB_PATH_REFERENCE

public static final String SUB_PATH_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

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

USES_REFERENCE

public static final String USES_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

getCombinedPathOccurrenceVector

public Vector getCombinedPathOccurrenceVector()

Gets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR. This Vector can be populated with CombinedPathOccurrence that is associated to a parent PathOccurrence.

Supported API: true

Returns:

Vector

setCombinedPathOccurrenceVector

public void setCombinedPathOccurrenceVector(Vector a_CombinedPathOccurrenceVector)
                                     throws WTPropertyVetoException

Sets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR. This Vector can be populated with CombinedPathOccurrence that is associated to a parent PathOccurrence.

Supported API: true

Parameters:

a_CombinedPathOccurrenceVector -

Throws:

WTPropertyVetoException

getUses

public UsesOccurrence getUses()

Gets the value of the attribute: USES. This non-persistent value stores the UsesOccurrence that was used to retrieve the PathOccurrence. This is necessary since the PathOccurrence only has a UsesOccurrenceReference, which could refer to more than one UsesOccurrence.

Supported API: true

Returns:

UsesOccurrence

setUses

public void setUses(UsesOccurrence a_Uses)
             throws WTPropertyVetoException

Sets the value of the attribute: USES. This non-persistent value stores the UsesOccurrence that was used to retrieve the PathOccurrence. This is necessary since the PathOccurrence only has a UsesOccurrenceReference, which could refer to more than one UsesOccurrence.

Supported API: true

Parameters:

a_Uses -

Throws:

WTPropertyVetoException

getUsesName

public String getUsesName()

Gets the value of the attribute: USES_NAME.

Supported API: true

Returns:

String

setUsesName

public void setUsesName(String a_UsesName)
                 throws WTPropertyVetoException

Sets the value of the attribute: USES_NAME.

Supported API: true

Parameters:

a_UsesName -

Throws:

WTPropertyVetoException

getPathName

public String getPathName()

Gets the value of the attribute: PATH_NAME.

Supported API: true

Returns:

String

setPathName

public void setPathName(String a_PathName)
                 throws WTPropertyVetoException

Sets the value of the attribute: PATH_NAME.

Supported API: true

Parameters:

a_PathName -

Throws:

WTPropertyVetoException

getSubPath

public PathOccurrence getSubPath()

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

Supported API: false

Returns:

PathOccurrence

setSubPath

public void setSubPath(PathOccurrence a_SubPath)
                throws WTPropertyVetoException,
                       WTException

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

Supported API: false

Parameters:

a_SubPath -

Throws:

WTPropertyVetoException

WTException

getSubPathReference

public ObjectReference getSubPathReference()

Gets the value of the attribute: SUB_PATH_REFERENCE.

Supported API: false

Returns:

ObjectReference

setSubPathReference

public void setSubPathReference(ObjectReference a_SubPathReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: SUB_PATH_REFERENCE.

Supported API: false

Parameters:

a_SubPathReference -

Throws:

WTPropertyVetoException

getContext

public PathOccurrenceMasterContext getContext()

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

Supported API: false

Specified by:

getContext in interface PathParentableOccurrence

Returns:

PathOccurrenceMasterContext

setContext

public void setContext(PathOccurrenceMasterContext 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

getUsesReference

public UsesOccurrenceReference getUsesReference()

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

Supported API: false

Returns:

UsesOccurrenceReference

setUsesReference

public void setUsesReference(UsesOccurrenceReference a_UsesReference)
                      throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_UsesReference -

Throws:

WTPropertyVetoException

hasSubPath

public boolean hasSubPath()

Returns true if the PathOccurrence has a non-null sub path.

Supported API: true

Returns:

boolean

getPathList

public Vector getPathList()

Returns a Vector of the PathOccurrence objects that make up this path. A root node in a path structure could just return itself in a list of length 1.

Supported API: true

Returns:

Vector