wt.dataops.objectcol
Class BaseCriterionDef

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.dataops.objectcol.BaseCriterionDef

All Implemented Interfaces:

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

Direct Known Subclasses:

CollectionCriterionDef, FilterCriterionDef, MethodDef, RelationshipMapDef

public class BaseCriterionDef

extends Simple

implements Iterated, Persistable, Externalizable

Use the newBaseCriterionDef static factory method(s), not the BaseCriterionDef 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: false

Extendable: false

See Also:

Serialized Form

Field Summary

protected BaseXMLDefAdapter	baseXMLDef
private static String	CLASSNAME
private ControlBranch	controlBranch
static long	EXTERNALIZATION_VERSION_UID
private IterationInfo	iterationInfo
private ObjectReference	masterReference
private static String	RESOURCE
(package private) static long	serialVersionUID
private XMLLob	spec

Fields inherited from class wt.enterprise.Simple

OLD_FORMAT_VERSION_UID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MASTER, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

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

BaseCriterionDef()

Method Summary

protected BaseXMLDefAdapter	createDefaultXMLDefAdapter()
protected Map	createInputMap(InputValue[] inputs, BaseXMLDefAdapter adapter)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
protected InputValue	findInputWithName(String name, InputValue[] vals)
InputValue[]	getAllInputs() Supported API: false
long	getBranchIdentifier() Gets the value of the attribute: branchIdentifier; Derived attribute for displaying the iteration's branch identifier in query results.
String	getConceptualClassname() Deprecated.
protected Element	getConditionElement()
protected Element	getContentElement()
ControlBranch	getControlBranch() Gets the value of the attribute: controlBranch.
WTPrincipalReference	getCreator() Gets the value of the attribute: creator; Derived attribute for displaying the Version Creator.
String	getCreatorEMail() Gets the value of the attribute: creatorEMail; Derived attribute for displaying the iteration creator's E-Mail address in query results.
String	getCreatorFullName() Gets the value of the attribute: creatorFullName; Derived attribute for displaying the iteration creator's fullname in query results.
String	getCreatorName() Gets the value of the attribute: creatorName; Derived attribute for displaying the iteration creator's name in query results.
String	getDescription() Supported API: false
String	getDescription(Locale locale) Supported API: false
String	getDisplayName() Supported API: false
String	getDisplayName(Locale locale) Supported API: false
protected Element	getFilterElement()
protected InputValue[]	getInputs(boolean required)
protected InputType	getInputTypeFromType(String type)
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: iterationIdentifier; Derived attribute for displaying the iteration identifier in query results.
IterationInfo	getIterationInfo() Gets the object for the association that plays role: iterationInfo; The iteration cookie aggregated in any business object that asserts itself as being iterated.
String	getIterationNote() Gets the value of the attribute: iterationNote; Derived attribute for displaying the iteration's note in query results.
Mastered	getMaster() Gets the object for the association that plays role: master.
ObjectReference	getMasterReference() Gets the value of the attribute: masterReference.
WTPrincipalReference	getModifier() Gets the value of the attribute: modifier; Derived attribute for displaying the iteration's modifier in query results.
String	getModifierEMail() Gets the value of the attribute: modifierEMail; Derived attribute for displaying the iteration modifier's E-Mail address in query results.
String	getModifierFullName() Gets the value of the attribute: modifierFullName; Derived attribute for displaying the iteration modifier's fullname in query results.
String	getModifierName() Gets the value of the attribute: modifierName; Derived attribute for displaying the iteration modifier's name in query results.
String	getName() Gets the value of the attribute: name.
InputValue[]	getRequiredInputs() Supported API: false
XMLLob	getSpec() Gets the value of the attribute: spec.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supported API: false
boolean	isLatestIteration() Gets the value of the attribute: latestIteration; Derived attribute for displaying the iteration "latest" flag in query results.
boolean	isPrimaryDef() Gets the value of the attribute: primaryDef.
private void	iterationInfoValidate(IterationInfo a_IterationInfo)
protected List	makeValueList(InputType type, String value)
private void	masterReferenceValidate(ObjectReference a_MasterReference)
static BaseCriterionDef	newBaseCriterionDef() Default factory for the class.
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.
void	setControlBranch(ControlBranch a_ControlBranch) Sets the value of the attribute: controlBranch.
void	setDescription(String description) Supported API: false
void	setDisplayName(String displayName) Supported API: false
void	setIterationInfo(IterationInfo a_IterationInfo) Sets the object for the association that plays role: iterationInfo; The iteration cookie aggregated in any business object that asserts itself as being iterated.
void	setMaster(Mastered a_Master) Sets the object for the association that plays role: master.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: masterReference.
void	setName(String a_Name) Sets the value of the attribute: name.
void	setPrimaryDef(boolean a_PrimaryDef) Sets the value of the attribute: primaryDef.
void	setSpec(XMLLob a_Spec) Sets the value of the attribute: spec.
boolean	validateInputs(InputValue[] inputs) Supported API: false
protected boolean	validateValue(String name, InputType type, String 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 wt.enterprise.Simple

getBusinessType, getDomainRef, getEventSet, getIdentity, 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

spec

private XMLLob spec

masterReference

private ObjectReference masterReference

controlBranch

private ControlBranch controlBranch

iterationInfo

private IterationInfo iterationInfo

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

baseXMLDef

protected BaseXMLDefAdapter baseXMLDef

Constructor Detail

BaseCriterionDef

public BaseCriterionDef()

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

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

getSpec

public XMLLob getSpec()

Gets the value of the attribute: spec.

Supported API: false

Returns:

XMLLob

setSpec

public void setSpec(XMLLob a_Spec)
             throws WTPropertyVetoException

Sets the value of the attribute: spec.

Supported API: false

Parameters:

a_Spec -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: name.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: name.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

isPrimaryDef

public boolean isPrimaryDef()

Gets the value of the attribute: primaryDef.

Supported API: false

Returns:

boolean

setPrimaryDef

public void setPrimaryDef(boolean a_PrimaryDef)
                   throws WTPropertyVetoException

Sets the value of the attribute: primaryDef.

Supported API: false

Parameters:

a_PrimaryDef -

Throws:

WTPropertyVetoException

getMaster

public Mastered getMaster()

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

Supported API: false

Specified by:

getMaster in interface Iterated

Returns:

Mastered

See Also:

Mastered

setMaster

public void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Specified by:

setMaster in interface Iterated

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

getMasterReference

public ObjectReference getMasterReference()

Gets the value of the attribute: masterReference.

Supported API: false

Specified by:

getMasterReference in interface Iterated

Returns:

ObjectReference

See Also:

Mastered

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: masterReference.

Supported API: false

Specified by:

setMasterReference in interface Iterated

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

getRequiredInputs

public InputValue[] getRequiredInputs()
                               throws WTException

Supported API: false

Returns:

InputValue[]

Throws:

WTException

validateInputs

public boolean validateInputs(InputValue[] inputs)
                       throws WTException

Supported API: false

Parameters:

inputs -

Returns:

boolean

Throws:

WTException

getDisplayName

public String getDisplayName(Locale locale)

Supported API: false

Parameters:

locale -

Returns:

String

getDescription

public String getDescription(Locale locale)

Supported API: false

Parameters:

locale -

Returns:

String

initialize

protected void initialize()
                   throws WTException

Supported API: false

Overrides:

initialize in class Simple

Throws:

WTException

getAllInputs

public InputValue[] getAllInputs()
                          throws WTException

Supported API: false

Returns:

InputValue[]

Throws:

WTException

setDisplayName

public void setDisplayName(String displayName)
                    throws WTPropertyVetoException

Supported API: false

Parameters:

displayName -

Throws:

WTPropertyVetoException

setDescription

public void setDescription(String description)
                    throws WTPropertyVetoException

Supported API: false

Parameters:

description -

Throws:

WTPropertyVetoException

getDisplayName

public String getDisplayName()

Supported API: false

Returns:

String

getDescription

public String getDescription()

Supported API: false

Returns:

String

newBaseCriterionDef

public static BaseCriterionDef newBaseCriterionDef()
                                            throws WTException

Default factory for the class.

Supported API: false

Returns:

BaseCriterionDef

Throws:

WTException

getIterationNote

public String getIterationNote()

Gets the value of the attribute: iterationNote; Derived attribute for displaying the iteration's note in query results.

Supported API: false

Specified by:

getIterationNote in interface Iterated

Returns:

String

getCreatorEMail

public String getCreatorEMail()

Gets the value of the attribute: creatorEMail; Derived attribute for displaying the iteration creator's E-Mail address in query results.

Supported API: false

Specified by:

getCreatorEMail in interface Iterated

Returns:

String

getCreatorName

public String getCreatorName()

Gets the value of the attribute: creatorName; Derived attribute for displaying the iteration creator's name in query results.

Supported API: false

Specified by:

getCreatorName in interface Iterated

Returns:

String

getCreatorFullName

public String getCreatorFullName()

Gets the value of the attribute: creatorFullName; Derived attribute for displaying the iteration creator's fullname in query results.

Supported API: false

Specified by:

getCreatorFullName in interface Iterated

Returns:

String

getModifier

public WTPrincipalReference getModifier()

Gets the value of the attribute: modifier; Derived attribute for displaying the iteration's modifier in query results.

Supported API: false

Specified by:

getModifier in interface Iterated

Returns:

WTPrincipalReference

getModifierEMail

public String getModifierEMail()

Gets the value of the attribute: modifierEMail; Derived attribute for displaying the iteration modifier's E-Mail address in query results.

Supported API: false

Specified by:

getModifierEMail in interface Iterated

Returns:

String

getModifierName

public String getModifierName()

Gets the value of the attribute: modifierName; Derived attribute for displaying the iteration modifier's name in query results.

Supported API: false

Specified by:

getModifierName in interface Iterated

Returns:

String

getModifierFullName

public String getModifierFullName()

Gets the value of the attribute: modifierFullName; Derived attribute for displaying the iteration modifier's fullname in query results.

Supported API: false

Specified by:

getModifierFullName in interface Iterated

Returns:

String

getIterationIdentifier

public IterationIdentifier getIterationIdentifier()

Gets the value of the attribute: iterationIdentifier; Derived attribute for displaying the iteration identifier in query results.

Supported API: false

Specified by:

getIterationIdentifier in interface Iterated

Returns:

IterationIdentifier

getBranchIdentifier

public long getBranchIdentifier()

Gets the value of the attribute: branchIdentifier; Derived attribute for displaying the iteration's branch identifier in query results.

Supported API: false

Specified by:

getBranchIdentifier in interface Iterated

Returns:

long

isLatestIteration

public boolean isLatestIteration()

Gets the value of the attribute: latestIteration; Derived attribute for displaying the iteration "latest" flag in query results.

Supported API: false

Specified by:

isLatestIteration in interface Iterated

Returns:

boolean

getCreator

public WTPrincipalReference getCreator()

Gets the value of the attribute: creator; Derived attribute for displaying the Version Creator. Will be the same for each iteration of a Version. A Version corresponds to all iterations for a given branchId

Supported API: false

Specified by:

getCreator in interface Iterated

Returns:

WTPrincipalReference

getControlBranch

public ControlBranch getControlBranch()

Gets the value of the attribute: controlBranch.

Supported API: false

Specified by:

getControlBranch in interface Iterated

Returns:

ControlBranch

setControlBranch

public void setControlBranch(ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: controlBranch.

Supported API: false

Specified by:

setControlBranch in interface Iterated

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

getIterationInfo

public IterationInfo getIterationInfo()

Gets the object for the association that plays role: iterationInfo; The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

getIterationInfo in interface Iterated

Returns:

IterationInfo

See Also:

IterationInfo

setIterationInfo

public void setIterationInfo(IterationInfo a_IterationInfo)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: iterationInfo; The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Specified by:

setIterationInfo in interface Iterated

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

See Also:

IterationInfo

iterationInfoValidate

private void iterationInfoValidate(IterationInfo a_IterationInfo)
                            throws WTPropertyVetoException

Parameters:

a_IterationInfo -

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

validateValue

protected boolean validateValue(String name,
                                InputType type,
                                String value)
                         throws WTException

Throws:

WTException

getInputTypeFromType

protected InputType getInputTypeFromType(String type)

createDefaultXMLDefAdapter

protected BaseXMLDefAdapter createDefaultXMLDefAdapter()
                                                throws WTException,
                                                       NoSuchDomElementException

Throws:

WTException

NoSuchDomElementException

getContentElement

protected Element getContentElement()
                             throws WTException

Throws:

WTException

getConditionElement

protected Element getConditionElement()
                               throws WTException

Throws:

WTException

getFilterElement

protected Element getFilterElement()
                            throws WTException

Throws:

WTException

createInputMap

protected Map createInputMap(InputValue[] inputs,
                             BaseXMLDefAdapter adapter)
                      throws WTException

Throws:

WTException

makeValueList

protected List makeValueList(InputType type,
                             String value)
                      throws WTException

Throws:

WTException

findInputWithName

protected InputValue findInputWithName(String name,
                                       InputValue[] vals)

getInputs

protected InputValue[] getInputs(boolean required)
                          throws WTException,
                                 NoSuchDomElementException

Throws:

WTException

NoSuchDomElementException