wt.occurrence
Interface UsesOccurrence

All Superinterfaces:

NetFactor, ObjectMappable, Occurrence, Persistable, Serializable

All Known Implementing Classes:

EPMUsesOccurrence, PartUsesOccurrence

public interface UsesOccurrence
extends Occurrence

This UsesOccurrence identifies a unique instance of an OccurrenceableLink in order to deal with:

• the ambiguity inherent when links have quantity greater than 1
• the need to hang UsesOccurrenceData off of links
• the need to be a part of the path of UsesOccurrences that define a PathOccurrence

The usesOccurrenceIdentifier is used to link to the PathOccurrence; the usesOccurrenceIdentifier is generated when a brand new UsesOccurrence is created and then it is preserved when new copies are made in response to an OccurrenceableLink being copied forward.

You must use one of the OccurrenceService.saveUsesOccurrenceAndData(wt.occurrence.UsesOccurrence, java.util.Vector) methods when saving a UsesOccurrence because of a special optimization that allows UsesOccurrenceData to be managed more efficiently.

Supported API: true

Extendable: true

Field Summary

static String	USES_NAME Label for the attribute; This alias for the name attribute is useful in some cases by introspection so that the name of a UsesOccurrence is distinct from the name of other Occurrences.
static String	USES_OCCURRENCE_IDENTIFIER Label for the attribute; This identifier is shared by many OccurrenceableLink objects, all of which represent the same link, except maybe for different iterations or versions of objects being linked.

Fields inherited from interface wt.occurrence.Occurrence

NAME, OCCURRENCE_DATA_VECTOR

Method Summary

String	getUsesName() Gets the value of the attribute: USES_NAME.
long	getUsesOccurrenceIdentifier() Gets the value of the attribute: USES_OCCURRENCE_IDENTIFIER.
boolean	isPlaceholder() Returns true if the UsesOccurrence is only used to complete a PathOccurrence and has no other useful information associated with it.
void	setUsesName(String a_UsesName) Sets the value of the attribute: USES_NAME.
void	setUsesOccurrenceIdentifier(long a_UsesOccurrenceIdentifier) Sets the value of the attribute: USES_OCCURRENCE_IDENTIFIER.

Methods inherited from interface wt.occurrence.Occurrence

getName, getOccurrenceDataVector, setName, setOccurrenceDataVector

Field Detail

USES_OCCURRENCE_IDENTIFIER

static final String USES_OCCURRENCE_IDENTIFIER

Label for the attribute; This identifier is shared by many OccurrenceableLink objects, all of which represent the same link, except maybe for different iterations or versions of objects being linked. In other words, when the OccurrenceableLink is copied forward this identifier is copied without changing its value.

Supported API: true

See Also:

Constant Field Values

USES_NAME

static final String USES_NAME

Label for the attribute; This alias for the name attribute is useful in some cases by introspection so that the name of a UsesOccurrence is distinct from the name of other Occurrences.

Supported API: true

See Also:

Constant Field Values

Method Detail

getUsesOccurrenceIdentifier

long getUsesOccurrenceIdentifier()

Gets the value of the attribute: USES_OCCURRENCE_IDENTIFIER. This identifier is shared by many OccurrenceableLink objects, all of which represent the same link, except maybe for different iterations or versions of objects being linked. In other words, when the OccurrenceableLink is copied forward this identifier is copied without changing its value.

Supported API: true

Returns:

long

setUsesOccurrenceIdentifier

void setUsesOccurrenceIdentifier(long a_UsesOccurrenceIdentifier)
                                 throws WTPropertyVetoException

Sets the value of the attribute: USES_OCCURRENCE_IDENTIFIER. This identifier is shared by many OccurrenceableLink objects, all of which represent the same link, except maybe for different iterations or versions of objects being linked. In other words, when the OccurrenceableLink is copied forward this identifier is copied without changing its value.

Supported API: true

Parameters:

a_UsesOccurrenceIdentifier -

Throws:

WTPropertyVetoException

getUsesName

String getUsesName()

Gets the value of the attribute: USES_NAME. This alias for the name attribute is useful in some cases by introspection so that the name of a UsesOccurrence is distinct from the name of other Occurrences.

Supported API: true

Returns:

String

setUsesName

void setUsesName(String a_UsesName)
                 throws WTPropertyVetoException

Sets the value of the attribute: USES_NAME. This alias for the name attribute is useful in some cases by introspection so that the name of a UsesOccurrence is distinct from the name of other Occurrences.

Supported API: true

Parameters:

a_UsesName -

Throws:

WTPropertyVetoException

isPlaceholder

boolean isPlaceholder()

Returns true if the UsesOccurrence is only used to complete a PathOccurrence and has no other useful information associated with it.

Supported API: true

Returns:

boolean