wt.eff
Class EffConfigSpec

java.lang.Object
  wt.eff.EffConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, NetFactor, ObjectMappable, ConfigSpec

public class EffConfigSpec
extends Object
implements NetFactor, ConfigSpec, ObjectMappable, Externalizable

A primitive config spec used to filter based on an Eff, its EffContext and a value for which the EffManagedVersion should be effective.

Use the newEffConfigSpec static factory method(s), not the EffConfigSpec constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

appendSearchCriteria(wt.query.QuerySpec), process(wt.fc.QueryResult), Serialized Form

Field Summary

static String

EFF_CONTEXT Label for the attribute; The context for which the value should be applied to.

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Restricts the query to return only those items with the specified EffConfigSpec#effContext and whose value is between the start and end values any effectivities.
EffContext	getEffContext() Gets the value of the attribute: EFF_CONTEXT.
protected void	initialize(EffContext an_EffContext, Class an_EffType) Supports initialization, following construction of an instance.
protected void	initialize(EffContext an_EffContext, Class an_EffType, Serializable a_Value) Supports initialization, following construction of an instance.
protected void	initialize(EffContext an_EffContext, Class an_EffType, String a_ValueAsString) Supports initialization, following construction of an instance.
static EffConfigSpec	newEffConfigSpec(EffContext an_EffContext, Class an_EffType) Factory to construct an EffConfigSpec based on the context and a type.
static EffConfigSpec	newEffConfigSpec(EffContext an_EffContext, Class an_EffType, Serializable a_Value) Factory to construct an EffConfigSpec based on the context, a type, and a value.
static EffConfigSpec	newEffConfigSpec(EffContext an_EffContext, Class an_EffType, String a_ValueAsString) Factory to construct an EffConfigSpec based on the context, a type, and string value.
QueryResult	process(QueryResult results) Returns the elements passed in.
void	setEffContext(EffContext a_EffContext) Sets the value of the attribute: EFF_CONTEXT.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EFF_CONTEXT

public static final String EFF_CONTEXT

Label for the attribute; The context for which the value should be applied to.

Supported API: true

See Also:

Constant Field Values

Method Detail

getEffContext

public EffContext getEffContext()
                         throws ObjectNoLongerExistsException

Gets the value of the attribute: EFF_CONTEXT. The context for which the value should be applied to.

Supported API: true

Returns:

EffContext

Throws:

ObjectNoLongerExistsException

setEffContext

public void setEffContext(EffContext a_EffContext)
                   throws WTPropertyVetoException

Sets the value of the attribute: EFF_CONTEXT. The context for which the value should be applied to.

Supported API: true

Parameters:

a_EffContext -

Throws:

WTPropertyVetoException

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Restricts the query to return only those items with the specified EffConfigSpec#effContext and whose value is between the start and end values any effectivities. It also must handle the possibility of null values for the end of an effectivity range.

Supported API: true

Specified by:

appendSearchCriteria in interface ConfigSpec

Parameters:

querySpec - A QuerySpec with a target class that is Iterated.

Returns:

QuerySpec

Throws:

WTException

QueryException

See Also:

QuerySpec, SearchCondition

process

public QueryResult process(QueryResult results)
                    throws WTException

Returns the elements passed in.

Supported API: true

Specified by:

process in interface ConfigSpec

Parameters:

results - QueryResult of iterations to filter. Assumed to be the result of a query that included the additional search conditions applied by appendSearchCriteria. Note that after enumerating through the elements of this QueryResult, it should be reset.

Returns:

QueryResult

Throws:

WTException

See Also:

QueryResult, Iterated

newEffConfigSpec

public static EffConfigSpec newEffConfigSpec(EffContext an_EffContext,
                                             Class an_EffType)
                                      throws WTPropertyVetoException

Factory to construct an EffConfigSpec based on the context and a type. The value is left null.

Supported API: true

Parameters:

an_EffContext -

an_EffType -

Returns:

EffConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(EffContext an_EffContext,
                          Class an_EffType)
                   throws WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

an_EffContext -

an_EffType -

Throws:

WTPropertyVetoException

newEffConfigSpec

public static EffConfigSpec newEffConfigSpec(EffContext an_EffContext,
                                             Class an_EffType,
                                             Serializable a_Value)
                                      throws WTPropertyVetoException

Factory to construct an EffConfigSpec based on the context, a type, and a value.

Supported API: true

Parameters:

an_EffContext -

an_EffType -

a_Value -

Returns:

EffConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(EffContext an_EffContext,
                          Class an_EffType,
                          Serializable a_Value)
                   throws WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

an_EffContext -

an_EffType -

a_Value -

Throws:

WTPropertyVetoException

newEffConfigSpec

public static EffConfigSpec newEffConfigSpec(EffContext an_EffContext,
                                             Class an_EffType,
                                             String a_ValueAsString)
                                      throws WTPropertyVetoException

Factory to construct an EffConfigSpec based on the context, a type, and string value.

Supported API: true

Parameters:

an_EffContext -

an_EffType -

a_ValueAsString -

Returns:

EffConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(EffContext an_EffContext,
                          Class an_EffType,
                          String a_ValueAsString)
                   throws WTPropertyVetoException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

an_EffContext -

an_EffType -

a_ValueAsString -

Throws:

WTPropertyVetoException