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	CONTEXT Label for the attribute.
static String	CONTEXT_REFERENCE Label for the attribute.
static String	LINK Label for the attribute.
static String	LINK_REFERENCE Label for the attribute.
static String	PATH_OCCURRENCE Label for the attribute; This non-persistent PathOccurrence can be populated to hold the value that applies in a particular situation.
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_DATA_IDENTIFIER Label for the attribute; This identifier is used to improve efficiency so that many UsesOccurrenceData objects can have the same foreign key link to this UsesOccurrence and several UsesOccurrence objects can also share this same identifier, but only if all of their associated UsesOccurrenceData objects are the same.
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

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

UsesOccurrenceContext	getContext() Gets the object for the association that plays role: CONTEXT.
ObjectReference	getContextReference() Gets the value of the attribute: CONTEXT_REFERENCE.
OccurrenceableLink	getLink() Gets the object for the association that plays role: LINK.
ObjectReference	getLinkReference() Gets the value of the attribute: LINK_REFERENCE.
PathOccurrence	getPathOccurrence() Gets the value of the attribute: PATH_OCCURRENCE.
String	getUsesName() Gets the value of the attribute: USES_NAME.
long	getUsesOccurrenceDataIdentifier() Gets the value of the attribute: USES_OCCURRENCE_DATA_IDENTIFIER.
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	setContext(UsesOccurrenceContext 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	setLink(OccurrenceableLink a_Link) Sets the object for the association that plays role: LINK.
void	setLinkReference(ObjectReference a_LinkReference) Sets the value of the attribute: LINK_REFERENCE.
void	setPathOccurrence(PathOccurrence a_PathOccurrence) Sets the value of the attribute: PATH_OCCURRENCE.
void	setUsesName(String a_UsesName) Sets the value of the attribute: USES_NAME.
void	setUsesOccurrenceDataIdentifier(long a_UsesOccurrenceDataIdentifier) Sets the value of the attribute: USES_OCCURRENCE_DATA_IDENTIFIER.
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

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

USES_OCCURRENCE_DATA_IDENTIFIER

public static final String USES_OCCURRENCE_DATA_IDENTIFIER

Label for the attribute; This identifier is used to improve efficiency so that many UsesOccurrenceData objects can have the same foreign key link to this UsesOccurrence and several UsesOccurrence objects can also share this same identifier, but only if all of their associated UsesOccurrenceData objects are the same. If several UsesOccurrences share the same UsesOccurrenceData objects and one wants to change it (without affecting the others), then it must get a new identifier for itself and make copies of all of its OccurrenceData objects and link to those new copies by putting its new identifier into them as a foreign key. Finally it can change this new set of data as desired without affecting other UsesOccurrences. Because of the complex management of this attribute it is necessary to call one of the OccurrenceService.saveUsesOccurrenceAndData(wt.occurrence.UsesOccurrence, java.util.Vector) methods when saving a UsesOccurrence (and optionally its associated UsesOccurenceData.

Supported API: false

See Also:

Constant Field Values

USES_OCCURRENCE_IDENTIFIER

public 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

PATH_OCCURRENCE

public static final String PATH_OCCURRENCE

Label for the attribute; This non-persistent PathOccurrence can be populated to hold the value that applies in a particular situation.

Supported API: false

See Also:

Constant Field Values

USES_NAME

public 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

LINK

public static final String LINK

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

LINK_REFERENCE

public static final String LINK_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

Method Detail

getUsesOccurrenceDataIdentifier

public long getUsesOccurrenceDataIdentifier()

Gets the value of the attribute: USES_OCCURRENCE_DATA_IDENTIFIER. This identifier is used to improve efficiency so that many UsesOccurrenceData objects can have the same foreign key link to this UsesOccurrence and several UsesOccurrence objects can also share this same identifier, but only if all of their associated UsesOccurrenceData objects are the same. If several UsesOccurrences share the same UsesOccurrenceData objects and one wants to change it (without affecting the others), then it must get a new identifier for itself and make copies of all of its OccurrenceData objects and link to those new copies by putting its new identifier into them as a foreign key. Finally it can change this new set of data as desired without affecting other UsesOccurrences. Because of the complex management of this attribute it is necessary to call one of the OccurrenceService.saveUsesOccurrenceAndData(wt.occurrence.UsesOccurrence, java.util.Vector) methods when saving a UsesOccurrence (and optionally its associated UsesOccurenceData.

Supported API: false

Returns:

long

setUsesOccurrenceDataIdentifier

public void setUsesOccurrenceDataIdentifier(long a_UsesOccurrenceDataIdentifier)
                                     throws WTPropertyVetoException

Sets the value of the attribute: USES_OCCURRENCE_DATA_IDENTIFIER. This identifier is used to improve efficiency so that many UsesOccurrenceData objects can have the same foreign key link to this UsesOccurrence and several UsesOccurrence objects can also share this same identifier, but only if all of their associated UsesOccurrenceData objects are the same. If several UsesOccurrences share the same UsesOccurrenceData objects and one wants to change it (without affecting the others), then it must get a new identifier for itself and make copies of all of its OccurrenceData objects and link to those new copies by putting its new identifier into them as a foreign key. Finally it can change this new set of data as desired without affecting other UsesOccurrences. Because of the complex management of this attribute it is necessary to call one of the OccurrenceService.saveUsesOccurrenceAndData(wt.occurrence.UsesOccurrence, java.util.Vector) methods when saving a UsesOccurrence (and optionally its associated UsesOccurenceData.

Supported API: false

Parameters:

a_UsesOccurrenceDataIdentifier -

Throws:

WTPropertyVetoException

getUsesOccurrenceIdentifier

public 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

public 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

getPathOccurrence

public PathOccurrence getPathOccurrence()

Gets the value of the attribute: PATH_OCCURRENCE. This non-persistent PathOccurrence can be populated to hold the value that applies in a particular situation.

Supported API: false

Returns:

PathOccurrence

setPathOccurrence

public void setPathOccurrence(PathOccurrence a_PathOccurrence)

Sets the value of the attribute: PATH_OCCURRENCE. This non-persistent PathOccurrence can be populated to hold the value that applies in a particular situation.

Supported API: false

Parameters:

a_PathOccurrence -

getUsesName

public 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

public 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

getLink

public OccurrenceableLink getLink()

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

Supported API: false

Returns:

OccurrenceableLink

setLink

public void setLink(OccurrenceableLink a_Link)
             throws WTPropertyVetoException,
                    WTException

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

Supported API: false

Parameters:

a_Link -

Throws:

WTPropertyVetoException

WTException

getLinkReference

public ObjectReference getLinkReference()

Gets the value of the attribute: LINK_REFERENCE.

Supported API: false

Returns:

ObjectReference

setLinkReference

public void setLinkReference(ObjectReference a_LinkReference)
                      throws WTPropertyVetoException

Sets the value of the attribute: LINK_REFERENCE.

Supported API: false

Parameters:

a_LinkReference -

Throws:

WTPropertyVetoException

getContext

public UsesOccurrenceContext getContext()

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

Supported API: false

Returns:

UsesOccurrenceContext

setContext

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

isPlaceholder

public 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