wt.eff
Class PersistableEffConfigSpec

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.eff.PersistableEffConfigSpec

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, DisplayIdentification, Notifiable, ConfigSpec

public class PersistableEffConfigSpec
extends Simple
implements ConfigSpec, Persistable, Externalizable

Persistent wrapper of an EffConfigSpec (which is ObjectMappable). This PersistableEffConfigSpec can be associated to an EffConfigSpecGroup.

Use the newPersistableEffConfigSpec static factory method(s), not the PersistableEffConfigSpec 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.
static String	EFF_TYPE Label for the attribute; The Eff class (type).
static String	VALUE Label for the attribute; The value represented by this Eff.
static String	VALUE_AS_STRING Label for the attribute; The value, represented as a String.

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends a 'context = and start <= and (end >= or end = null' to the QuerySpec.
EffContext	getEffContext() Gets the value of the attribute: EFF_CONTEXT.
Class	getEffType() Gets the value of the attribute: EFF_TYPE.
Serializable	getValue() Gets the value of the attribute: VALUE.
String	getValueAsString() Gets the value of the attribute: VALUE_AS_STRING.
protected void	initialize(EffConfigSpec an_EffConfigSpec) 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 PersistableEffConfigSpec	newPersistableEffConfigSpec(EffConfigSpec an_EffConfigSpec) Factory to construct a PersistableEffConfigSpec based on the context and a type.
static PersistableEffConfigSpec	newPersistableEffConfigSpec(EffContext an_EffContext, Class an_EffType, Serializable a_Value) Factory to construct a PersistableEffConfigSpec based on the context, a type, and a value.
static PersistableEffConfigSpec	newPersistableEffConfigSpec(EffContext an_EffContext, Class an_EffType, String a_ValueAsString) Factory to construct a PersistableEffConfigSpec 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.
void	setValue(Serializable a_Value) Sets the value of the attribute: VALUE.
void	setValueAsString(String a_ValueAsString) Sets the value of the attribute: VALUE_AS_STRING.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

EFF_TYPE

public static final String EFF_TYPE

Label for the attribute; The Eff class (type).

Supported API: true

See Also:

Constant Field Values

VALUE

public static final String VALUE

Label for the attribute; The value represented by this Eff.

Supported API: true

See Also:

Constant Field Values

VALUE_AS_STRING

public static final String VALUE_AS_STRING

Label for the attribute; The value, represented as a String.

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

getEffType

public Class getEffType()

Gets the value of the attribute: EFF_TYPE. The Eff class (type).

Supported API: true

Returns:

Class

getValue

public Serializable getValue()

Gets the value of the attribute: VALUE. The value represented by this Eff.

Supported API: true

Returns:

Serializable

setValue

public void setValue(Serializable a_Value)
              throws WTPropertyVetoException

Sets the value of the attribute: VALUE. The value represented by this Eff.

Supported API: true

Parameters:

a_Value -

Throws:

WTPropertyVetoException

getValueAsString

public String getValueAsString()

Gets the value of the attribute: VALUE_AS_STRING. The value, represented as a String.

Supported API: true

Returns:

String

setValueAsString

public void setValueAsString(String a_ValueAsString)
                      throws WTPropertyVetoException

Sets the value of the attribute: VALUE_AS_STRING. The value, represented as a String.

Supported API: true

Parameters:

a_ValueAsString -

Throws:

WTPropertyVetoException

appendSearchCriteria

public QuerySpec appendSearchCriteria(QuerySpec querySpec)
                               throws WTException,
                                      QueryException

Appends a 'context = and start <= and (end >= or end = null' to the QuerySpec.

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

newPersistableEffConfigSpec

public static PersistableEffConfigSpec newPersistableEffConfigSpec(EffConfigSpec an_EffConfigSpec)
                                                            throws WTPropertyVetoException

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

Supported API: true

Parameters:

an_EffConfigSpec -

Returns:

PersistableEffConfigSpec

Throws:

WTPropertyVetoException

initialize

protected void initialize(EffConfigSpec an_EffConfigSpec)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

an_EffConfigSpec -

Throws:

WTPropertyVetoException

newPersistableEffConfigSpec

public static PersistableEffConfigSpec newPersistableEffConfigSpec(EffContext an_EffContext,
                                                                   Class an_EffType,
                                                                   Serializable a_Value)
                                                            throws WTPropertyVetoException

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

Supported API: true

Parameters:

an_EffContext -

an_EffType -

a_Value -

Returns:

PersistableEffConfigSpec

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

newPersistableEffConfigSpec

public static PersistableEffConfigSpec newPersistableEffConfigSpec(EffContext an_EffContext,
                                                                   Class an_EffType,
                                                                   String a_ValueAsString)
                                                            throws WTPropertyVetoException

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

Supported API: true

Parameters:

an_EffContext -

an_EffType -

a_ValueAsString -

Returns:

PersistableEffConfigSpec

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