wt.eff
Class PersistableEffConfigSpec

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

All Implemented Interfaces:

AccessControlled, BusinessInformation, ConfigSpec, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable

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

private static String	CLASSNAME
static String	EFF_CONFIG_SPEC Label for the attribute; Internal storage mechanism for config spec info.
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).
private EffConfigSpec	effConfigSpec
static long	EXTERNALIZATION_VERSION_UID
static String	GROUP Label for the attribute; The group this PersistableEffConfigSpec is assigned to.
static String	GROUP_REFERENCE Label for the attribute; The group this PersistableEffConfigSpec is assigned to.
private ObjectReference	groupReference
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
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.

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

PersistableEffConfigSpec()

Method Summary

QuerySpec	appendSearchCriteria(QuerySpec querySpec) Appends a 'context = and start <= and (end >= or end = null' to the QuerySpec.
private void	effConfigSpecValidate(EffConfigSpec a_EffConfigSpec)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
EffConfigSpec	getEffConfigSpec() Gets the object for the association that plays role: EFF_CONFIG_SPEC.
EffContext	getEffContext() Gets the value of the attribute: EFF_CONTEXT.
Class	getEffType() Gets the value of the attribute: EFF_TYPE.
EffConfigSpecGroup	getGroup() Gets the object for the association that plays role: GROUP.
ObjectReference	getGroupReference() Gets the value of the attribute: GROUP_REFERENCE.
Serializable	getValue() Gets the value of the attribute: VALUE.
String	getValueAsString() Gets the value of the attribute: VALUE_AS_STRING.
private void	groupReferenceValidate(ObjectReference a_GroupReference)
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
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	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(PersistableEffConfigSpec thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setEffConfigSpec(EffConfigSpec a_EffConfigSpec) Sets the object for the association that plays role: EFF_CONFIG_SPEC.
void	setEffContext(EffContext a_EffContext) Sets the value of the attribute: EFF_CONTEXT.
void	setGroup(EffConfigSpecGroup a_Group) Sets the object for the association that plays role: GROUP.
void	setGroupReference(ObjectReference a_GroupReference) Sets the value of the attribute: GROUP_REFERENCE.
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.
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 wt.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, getIdentity, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

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

EFF_CONFIG_SPEC

public static final String EFF_CONFIG_SPEC

Label for the attribute; Internal storage mechanism for config spec info. Not intended for direct use.

Supported API: false

See Also:

Constant Field Values

effConfigSpec

private EffConfigSpec effConfigSpec

GROUP

public static final String GROUP

Label for the attribute; The group this PersistableEffConfigSpec is assigned to.

Supported API: false

See Also:

Constant Field Values

GROUP_REFERENCE

public static final String GROUP_REFERENCE

Label for the attribute; The group this PersistableEffConfigSpec is assigned to.

Supported API: false

See Also:

Constant Field Values

groupReference

private ObjectReference groupReference

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

Constructor Detail

PersistableEffConfigSpec

public PersistableEffConfigSpec()

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

Overrides:

writeExternal in class Simple

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

Overrides:

readExternal in class Simple

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(PersistableEffConfigSpec 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

Overrides:

writeExternal in class Simple

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

Overrides:

readExternal in class Simple

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

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

getEffConfigSpec

public EffConfigSpec getEffConfigSpec()

Gets the object for the association that plays role: EFF_CONFIG_SPEC. Internal storage mechanism for config spec info. Not intended for direct use.

Supported API: false

Returns:

EffConfigSpec

setEffConfigSpec

public void setEffConfigSpec(EffConfigSpec a_EffConfigSpec)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: EFF_CONFIG_SPEC. Internal storage mechanism for config spec info. Not intended for direct use.

Supported API: false

Parameters:

a_EffConfigSpec -

Throws:

WTPropertyVetoException

effConfigSpecValidate

private void effConfigSpecValidate(EffConfigSpec a_EffConfigSpec)
                            throws WTPropertyVetoException

Parameters:

a_EffConfigSpec -

Throws:

WTPropertyVetoException

getGroup

public EffConfigSpecGroup getGroup()

Gets the object for the association that plays role: GROUP. The group this PersistableEffConfigSpec is assigned to.

Supported API: false

Returns:

EffConfigSpecGroup

setGroup

public void setGroup(EffConfigSpecGroup a_Group)
              throws WTPropertyVetoException,
                     WTException

Sets the object for the association that plays role: GROUP. The group this PersistableEffConfigSpec is assigned to.

Supported API: false

Parameters:

a_Group -

Throws:

WTPropertyVetoException

WTException

getGroupReference

public ObjectReference getGroupReference()

Gets the value of the attribute: GROUP_REFERENCE. The group this PersistableEffConfigSpec is assigned to.

Supported API: false

Returns:

ObjectReference

setGroupReference

public void setGroupReference(ObjectReference a_GroupReference)
                       throws WTPropertyVetoException

Sets the value of the attribute: GROUP_REFERENCE. The group this PersistableEffConfigSpec is assigned to.

Supported API: false

Parameters:

a_GroupReference -

Throws:

WTPropertyVetoException

groupReferenceValidate

private void groupReferenceValidate(ObjectReference a_GroupReference)
                             throws WTPropertyVetoException

Parameters:

a_GroupReference -

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

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class Simple

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class Simple

Returns:

int