wt.eff
Class EffConfigSpec

java.lang.Object
  wt.eff.EffConfigSpec

All Implemented Interfaces:

ConfigSpec, Externalizable, NetFactor, ObjectMappable, Serializable

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

private static String	BRANCH_ID
private static String	CLASSNAME
static String	EFF_CONTEXT Label for the attribute; The context for which the value should be applied to.
private static String	EFF_CONTEXT_REF
static String	EFF_TYPE Label for the attribute; The Eff class (type).
private static int	EFF_TYPE_NAME_UPPER_LIMIT
private ObjectReference	effContextRef
private String	effTypeName
private static String	END
static long	EXTERNALIZATION_VERSION_UID
private static String	ID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private static String	START
private static String	TARGET_REF
private Serializable	value
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.

Constructor Summary

EffConfigSpec()

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.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
EffContext	getEffContext() Gets the value of the attribute: EFF_CONTEXT.
Class	getEffType() Gets the value of the attribute: EFF_TYPE.
private SearchCondition	getSearchCondition(String attr, String oper)
Serializable	getValue() Gets the value of the attribute: VALUE.
String	getValueAsString() Gets the value of the attribute: VALUE_AS_STRING.
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	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(EffConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
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.
String	toString() Returns the conceptual (modeled) name for the class.
private void	valueValidate(Serializable a_Value)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

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: false

See Also:

Constant Field Values

VALUE

public static final String VALUE

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

Supported API: false

See Also:

Constant Field Values

value

private Serializable value

VALUE_AS_STRING

public static final String VALUE_AS_STRING

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

Supported API: false

See Also:

Constant Field Values

EFF_TYPE_NAME_UPPER_LIMIT

private static int EFF_TYPE_NAME_UPPER_LIMIT

effTypeName

private String effTypeName

effContextRef

private ObjectReference effContextRef

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

BRANCH_ID

private static final String BRANCH_ID

See Also:

Constant Field Values

TARGET_REF

private static final String TARGET_REF

See Also:

Constant Field Values

EFF_CONTEXT_REF

private static final String EFF_CONTEXT_REF

See Also:

Constant Field Values

ID

private static final String ID

See Also:

Constant Field Values

START

private static final String START

See Also:

Constant Field Values

END

private static final String END

See Also:

Constant Field Values

Constructor Detail

EffConfigSpec

public EffConfigSpec()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EffConfigSpec thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

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: false

Returns:

Class

getValue

public Serializable getValue()

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

Supported API: false

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: false

Parameters:

a_Value -

Throws:

WTPropertyVetoException

valueValidate

private void valueValidate(Serializable a_Value)
                    throws WTPropertyVetoException

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: false

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: false

Parameters:

a_ValueAsString -

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

getSearchCondition

private SearchCondition getSearchCondition(String attr,
                                           String oper)
                                    throws QueryException

Throws:

QueryException