wt.csm.navigation
Class QueryFormElement

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.csm.navigation.AbstractQueryFormElement
              wt.csm.navigation.QueryFormElement

All Implemented Interfaces:

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

public class QueryFormElement

extends AbstractQueryFormElement

implements Externalizable

Use the newQueryFormElement static factory method(s), not the QueryFormElement 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

private static String	CLASSNAME
static String	DISPLAY_ORDER Label for the attribute.
private int	displayOrder
static String	ENFORCE_DEPENDENCIES Label for the attribute.
private boolean	enforceDependencies
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private boolean	visible
static String	VISIBLE Label for the attribute.

Fields inherited from class wt.csm.navigation.AbstractQueryFormElement

ABSTRACT_ATTRIBUTE_DEFINITION, ABSTRACT_ATTRIBUTE_DEFINITION_REFERENCE, ABSTRACT_QFELEMENT_VALUE, ABSTRACT_QUERY_FORM, ABSTRACT_QUERY_FORM_REFERENCE

Fields inherited from class wt.enterprise.Simple

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

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.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

QueryFormElement()

Method Summary

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.
int	getDisplayOrder() Gets the value of the attribute: DISPLAY_ORDER.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(AbstractAttributeDefinition attributeDefinition, AbstractQueryForm queryForm, boolean visible, boolean enforceDependencies, int displayOrder) Supports initialization, following construction of an instance.
boolean	isEnforceDependencies() Gets the value of the attribute: ENFORCE_DEPENDENCIES.
boolean	isVisible() Gets the value of the attribute: VISIBLE.
static QueryFormElement	newQueryFormElement() Supported API: false
static QueryFormElement	newQueryFormElement(AbstractAttributeDefinition attributeDefinition, AbstractQueryForm queryForm, boolean visible, boolean enforceDependencies, int displayOrder) Supported API: false
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(QueryFormElement thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDisplayOrder(int a_DisplayOrder) Sets the value of the attribute: DISPLAY_ORDER.
void	setEnforceDependencies(boolean a_EnforceDependencies) Sets the value of the attribute: ENFORCE_DEPENDENCIES.
void	setVisible(boolean a_Visible) Sets the value of the attribute: VISIBLE.
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.csm.navigation.AbstractQueryFormElement

getAbstractAttributeDefinition, getAbstractAttributeDefinitionReference, getAbstractQFElementValue, getAbstractQueryForm, getAbstractQueryFormReference, readVersion, setAbstractAttributeDefinition, setAbstractAttributeDefinitionReference, setAbstractQFElementValue, setAbstractQueryForm, setAbstractQueryFormReference

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.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

VISIBLE

public static final String VISIBLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

visible

private boolean visible

ENFORCE_DEPENDENCIES

public static final String ENFORCE_DEPENDENCIES

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

enforceDependencies

private boolean enforceDependencies

DISPLAY_ORDER

public static final String DISPLAY_ORDER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

displayOrder

private int displayOrder

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

QueryFormElement

public QueryFormElement()

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 AbstractQueryFormElement

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 AbstractQueryFormElement

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 AbstractQueryFormElement

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

isVisible

public boolean isVisible()

Gets the value of the attribute: VISIBLE.

Supported API: false

Returns:

boolean

setVisible

public void setVisible(boolean a_Visible)
                throws WTPropertyVetoException

Sets the value of the attribute: VISIBLE.

Supported API: false

Parameters:

a_Visible -

Throws:

WTPropertyVetoException

isEnforceDependencies

public boolean isEnforceDependencies()

Gets the value of the attribute: ENFORCE_DEPENDENCIES.

Supported API: false

Returns:

boolean

setEnforceDependencies

public void setEnforceDependencies(boolean a_EnforceDependencies)
                            throws WTPropertyVetoException

Sets the value of the attribute: ENFORCE_DEPENDENCIES.

Supported API: false

Parameters:

a_EnforceDependencies -

Throws:

WTPropertyVetoException

getDisplayOrder

public int getDisplayOrder()

Gets the value of the attribute: DISPLAY_ORDER.

Supported API: false

Returns:

int

setDisplayOrder

public void setDisplayOrder(int a_DisplayOrder)
                     throws WTPropertyVetoException

Sets the value of the attribute: DISPLAY_ORDER.

Supported API: false

Parameters:

a_DisplayOrder -

Throws:

WTPropertyVetoException

newQueryFormElement

public static QueryFormElement newQueryFormElement(AbstractAttributeDefinition attributeDefinition,
                                                   AbstractQueryForm queryForm,
                                                   boolean visible,
                                                   boolean enforceDependencies,
                                                   int displayOrder)
                                            throws WTException

Supported API: false

Parameters:

attributeDefinition -

queryForm -

visible -

enforceDependencies -

displayOrder -

Returns:

QueryFormElement

Throws:

WTException

initialize

protected void initialize(AbstractAttributeDefinition attributeDefinition,
                          AbstractQueryForm queryForm,
                          boolean visible,
                          boolean enforceDependencies,
                          int displayOrder)
                   throws WTException

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

Supported API: false

Parameters:

attributeDefinition -

queryForm -

visible -

enforceDependencies -

displayOrder -

Throws:

WTException

newQueryFormElement

public static QueryFormElement newQueryFormElement()
                                            throws WTException

Supported API: false

Returns:

QueryFormElement

Throws:

WTException

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 AbstractQueryFormElement

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 AbstractQueryFormElement

Returns:

int