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	PATH_NAME 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.

Method Summary

Vector	getCombinedPathOccurrenceVector() Gets the value of the attribute: COMBINED_PATH_OCCURRENCE_VECTOR.
Vector	getPathList() Returns a Vector of the PathOccurrence objects that make up this path.
String	getPathName() Gets the value of the attribute: PATH_NAME.
UsesOccurrence	getUses() Gets the value of the attribute: USES.
String	getUsesName() Gets the value of the attribute: USES_NAME.
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	setPathName(String a_PathName) Sets the value of the attribute: PATH_NAME.
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.

Field Detail

COMBINED_PATH_OCCURRENCE_VECTOR

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

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

static final String USES_NAME

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

PATH_NAME

static final String PATH_NAME

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getCombinedPathOccurrenceVector

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

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

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

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

String getUsesName()

Gets the value of the attribute: USES_NAME.

Supported API: true

Returns:

String

setUsesName

void setUsesName(String a_UsesName)
                 throws WTPropertyVetoException

Sets the value of the attribute: USES_NAME.

Supported API: true

Parameters:

a_UsesName -

Throws:

WTPropertyVetoException

getPathName

String getPathName()

Gets the value of the attribute: PATH_NAME.

Supported API: true

Returns:

String

setPathName

void setPathName(String a_PathName)
                 throws WTPropertyVetoException

Sets the value of the attribute: PATH_NAME.

Supported API: true

Parameters:

a_PathName -

Throws:

WTPropertyVetoException

hasSubPath

boolean hasSubPath()

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

Supported API: true

Returns:

boolean

getPathList

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