wt.eff
Interface Eff

All Superinterfaces:

NetFactor, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

DateEff, Effectivity, IncorporationDate, LeftFilledStringEff, StringEff

All Known Implementing Classes:

DatedEffectivity, ProductDateEffectivity, ProductLotNumberEffectivity, ProductSerialNumberEffectivity, UnitEffectivity, WTIncorporationDate

public interface Eff

extends Persistable

Provides the capability to specify when an EffManagedVersion is effective given a start and end (EffRange) and optionally an EffContext. Implementations of Eff may constrain the EffContext as well as make it required; implementations also may specify a subclass of EffRange and by doing so specify the type of the start/end values.

Effs are often grouped into an EffGroup.

Supported API: true

Extendable: true

See Also:

DateEff, StringEff, LeftFilledStringEff, IncorporationDate

Field Summary

static String	CREATION Label for the attribute.
static String	CREATION_REFERENCE Label for the attribute.
static String	DELETION Label for the attribute.
static String	DELETION_REFERENCE Label for the attribute.
static String	EFF_CONTEXT Label for the attribute; The context for which this Eff is valid.
static String	EFF_CONTEXT_REFERENCE Label for the attribute; The context for which this Eff is valid.
static String	RANGE Label for the attribute; The range for which this Eff is valid.
static String	TARGET Label for the attribute; The target for an Eff.
static String	TARGET_REFERENCE Label for the attribute; The target for an Eff.

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

EffChangeAudit	getCreation() Gets the object for the association that plays role: CREATION.
ObjectReference	getCreationReference() Gets the value of the attribute: CREATION_REFERENCE.
EffChangeAudit	getDeletion() Gets the object for the association that plays role: DELETION.
ObjectReference	getDeletionReference() Gets the value of the attribute: DELETION_REFERENCE.
EffContext	getEffContext() Gets the object for the association that plays role: EFF_CONTEXT.
ObjectReference	getEffContextReference() Gets the value of the attribute: EFF_CONTEXT_REFERENCE.
EffRange	getRange() Gets the object for the association that plays role: RANGE.
EffManagedVersion	getTarget() Gets the object for the association that plays role: TARGET.
VersionReference	getTargetReference() Gets the value of the attribute: TARGET_REFERENCE.
void	setCreation(EffChangeAudit a_Creation) Sets the object for the association that plays role: CREATION.
void	setCreationReference(ObjectReference a_CreationReference) Sets the value of the attribute: CREATION_REFERENCE.
void	setDeletion(EffChangeAudit a_Deletion) Sets the object for the association that plays role: DELETION.
void	setDeletionReference(ObjectReference a_DeletionReference) Sets the value of the attribute: DELETION_REFERENCE.
void	setEffContext(EffContext a_EffContext) Sets the object for the association that plays role: EFF_CONTEXT.
void	setEffContextReference(ObjectReference a_EffContextReference) Sets the value of the attribute: EFF_CONTEXT_REFERENCE.
void	setRange(EffRange a_Range) Sets the object for the association that plays role: RANGE.
void	setTarget(EffManagedVersion a_Target) Sets the object for the association that plays role: TARGET.
void	setTargetReference(VersionReference a_TargetReference) Sets the value of the attribute: TARGET_REFERENCE.

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

RANGE

public static final String RANGE

Label for the attribute; The range for which this Eff is valid.

Supported API: true

See Also:

Constant Field Values

TARGET

public static final String TARGET

Label for the attribute; The target for an Eff.

Supported API: true

See Also:

Constant Field Values

TARGET_REFERENCE

public static final String TARGET_REFERENCE

Label for the attribute; The target for an Eff.

Supported API: true

See Also:

Constant Field Values

EFF_CONTEXT

public static final String EFF_CONTEXT

Label for the attribute; The context for which this Eff is valid.

Supported API: true

See Also:

Constant Field Values

EFF_CONTEXT_REFERENCE

public static final String EFF_CONTEXT_REFERENCE

Label for the attribute; The context for which this Eff is valid.

Supported API: true

See Also:

Constant Field Values

CREATION

public static final String CREATION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

CREATION_REFERENCE

public static final String CREATION_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DELETION

public static final String DELETION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DELETION_REFERENCE

public static final String DELETION_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

getRange

public EffRange getRange()

Gets the object for the association that plays role: RANGE. The range for which this Eff is valid.

Supported API: true

Returns:

EffRange

setRange

public void setRange(EffRange a_Range)
              throws WTPropertyVetoException

Sets the object for the association that plays role: RANGE. The range for which this Eff is valid.

Supported API: true

Parameters:

a_Range -

Throws:

WTPropertyVetoException

getTarget

public EffManagedVersion getTarget()

Gets the object for the association that plays role: TARGET. The target for an Eff.

Supported API: true

Returns:

EffManagedVersion

setTarget

public void setTarget(EffManagedVersion a_Target)
               throws WTPropertyVetoException,
                      WTException

Sets the object for the association that plays role: TARGET. The target for an Eff.

Supported API: true

Parameters:

a_Target -

Throws:

WTPropertyVetoException

WTException

getTargetReference

public VersionReference getTargetReference()

Gets the value of the attribute: TARGET_REFERENCE. The target for an Eff.

Supported API: true

Returns:

VersionReference

setTargetReference

public void setTargetReference(VersionReference a_TargetReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: TARGET_REFERENCE. The target for an Eff.

Supported API: true

Parameters:

a_TargetReference -

Throws:

WTPropertyVetoException

getEffContext

public EffContext getEffContext()

Gets the object for the association that plays role: EFF_CONTEXT. The context for which this Eff is valid.

Supported API: true

Returns:

EffContext

setEffContext

public void setEffContext(EffContext a_EffContext)
                   throws WTPropertyVetoException,
                          WTException

Sets the object for the association that plays role: EFF_CONTEXT. The context for which this Eff is valid.

Supported API: true

Parameters:

a_EffContext -

Throws:

WTPropertyVetoException

WTException

getEffContextReference

public ObjectReference getEffContextReference()

Gets the value of the attribute: EFF_CONTEXT_REFERENCE. The context for which this Eff is valid.

Supported API: true

Returns:

ObjectReference

setEffContextReference

public void setEffContextReference(ObjectReference a_EffContextReference)
                            throws WTPropertyVetoException

Sets the value of the attribute: EFF_CONTEXT_REFERENCE. The context for which this Eff is valid.

Supported API: true

Parameters:

a_EffContextReference -

Throws:

WTPropertyVetoException

getCreation

public EffChangeAudit getCreation()

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

Supported API: false

Returns:

EffChangeAudit

setCreation

public void setCreation(EffChangeAudit a_Creation)
                 throws WTPropertyVetoException,
                        WTException

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

Supported API: false

Parameters:

a_Creation -

Throws:

WTPropertyVetoException

WTException

getCreationReference

public ObjectReference getCreationReference()

Gets the value of the attribute: CREATION_REFERENCE.

Supported API: false

Returns:

ObjectReference

setCreationReference

public void setCreationReference(ObjectReference a_CreationReference)
                          throws WTPropertyVetoException

Sets the value of the attribute: CREATION_REFERENCE.

Supported API: false

Parameters:

a_CreationReference -

Throws:

WTPropertyVetoException

getDeletion

public EffChangeAudit getDeletion()

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

Supported API: false

Returns:

EffChangeAudit

setDeletion

public void setDeletion(EffChangeAudit a_Deletion)
                 throws WTPropertyVetoException,
                        WTException

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

Supported API: false

Parameters:

a_Deletion -

Throws:

WTPropertyVetoException

WTException

getDeletionReference

public ObjectReference getDeletionReference()

Gets the value of the attribute: DELETION_REFERENCE.

Supported API: false

Returns:

ObjectReference

setDeletionReference

public void setDeletionReference(ObjectReference a_DeletionReference)
                          throws WTPropertyVetoException

Sets the value of the attribute: DELETION_REFERENCE.

Supported API: false

Parameters:

a_DeletionReference -

Throws:

WTPropertyVetoException