wt.csm.navigation
Class NodeQueryForm

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.csm.navigation.AbstractQueryForm
              wt.csm.navigation.NodeQueryForm

All Implemented Interfaces:

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

public class NodeQueryForm

extends AbstractQueryForm

implements Externalizable

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

static String	ABS_NODE Label for the attribute.
static String	ABS_NODE_REFERENCE Label for the attribute.
private ObjectReference	absNodeReference
private static String	CLASSNAME
static String	DEFAULT_QF Label for the attribute.
static String	DEFAULT_QFREFERENCE Label for the attribute.
private ObjectReference	defaultQFReference
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

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

NodeQueryForm()

Method Summary

private void	absNodeReferenceValidate(ObjectReference a_AbsNodeReference)
private void	defaultQFReferenceValidate(ObjectReference a_DefaultQFReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
AbstractNode	getAbsNode() Gets the object for the association that plays role: ABS_NODE.
ObjectReference	getAbsNodeReference() Gets the value of the attribute: ABS_NODE_REFERENCE.
String	getConceptualClassname() Deprecated.
DefaultQueryForm	getDefaultQF() Gets the object for the association that plays role: DEFAULT_QF.
ObjectReference	getDefaultQFReference() Gets the value of the attribute: DEFAULT_QFREFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(AbstractNode node, DefaultQueryForm defaultQueryForm) Supports initialization, following construction of an instance.
static NodeQueryForm	newNodeQueryForm() Supported API: false
static NodeQueryForm	newNodeQueryForm(AbstractNode node, DefaultQueryForm defaultQueryForm) 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(NodeQueryForm thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAbsNode(AbstractNode a_AbsNode) Sets the object for the association that plays role: ABS_NODE.
void	setAbsNodeReference(ObjectReference a_AbsNodeReference) Sets the value of the attribute: ABS_NODE_REFERENCE.
void	setDefaultQF(DefaultQueryForm a_DefaultQF) Sets the object for the association that plays role: DEFAULT_QF.
void	setDefaultQFReference(ObjectReference a_DefaultQFReference) Sets the value of the attribute: DEFAULT_QFREFERENCE.
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.AbstractQueryForm

readVersion

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

DEFAULT_QF

public static final String DEFAULT_QF

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DEFAULT_QFREFERENCE

public static final String DEFAULT_QFREFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

defaultQFReference

private ObjectReference defaultQFReference

ABS_NODE

public static final String ABS_NODE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

ABS_NODE_REFERENCE

public static final String ABS_NODE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

absNodeReference

private ObjectReference absNodeReference

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

NodeQueryForm

public NodeQueryForm()

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 AbstractQueryForm

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 AbstractQueryForm

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

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 AbstractQueryForm

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

getDefaultQF

public DefaultQueryForm getDefaultQF()

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

Supported API: false

Returns:

DefaultQueryForm

setDefaultQF

public void setDefaultQF(DefaultQueryForm a_DefaultQF)
                  throws WTPropertyVetoException,
                         WTException

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

Supported API: false

Parameters:

a_DefaultQF -

Throws:

WTPropertyVetoException

WTException

getDefaultQFReference

public ObjectReference getDefaultQFReference()

Gets the value of the attribute: DEFAULT_QFREFERENCE.

Supported API: false

Returns:

ObjectReference

setDefaultQFReference

public void setDefaultQFReference(ObjectReference a_DefaultQFReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: DEFAULT_QFREFERENCE.

Supported API: false

Parameters:

a_DefaultQFReference -

Throws:

WTPropertyVetoException

defaultQFReferenceValidate

private void defaultQFReferenceValidate(ObjectReference a_DefaultQFReference)
                                 throws WTPropertyVetoException

Parameters:

a_DefaultQFReference -

Throws:

WTPropertyVetoException

getAbsNode

public AbstractNode getAbsNode()

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

Supported API: false

Returns:

AbstractNode

setAbsNode

public void setAbsNode(AbstractNode a_AbsNode)
                throws WTPropertyVetoException,
                       WTException

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

Supported API: false

Parameters:

a_AbsNode -

Throws:

WTPropertyVetoException

WTException

getAbsNodeReference

public ObjectReference getAbsNodeReference()

Gets the value of the attribute: ABS_NODE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setAbsNodeReference

public void setAbsNodeReference(ObjectReference a_AbsNodeReference)
                         throws WTPropertyVetoException

Sets the value of the attribute: ABS_NODE_REFERENCE.

Supported API: false

Parameters:

a_AbsNodeReference -

Throws:

WTPropertyVetoException

absNodeReferenceValidate

private void absNodeReferenceValidate(ObjectReference a_AbsNodeReference)
                               throws WTPropertyVetoException

Parameters:

a_AbsNodeReference -

Throws:

WTPropertyVetoException

newNodeQueryForm

public static NodeQueryForm newNodeQueryForm(AbstractNode node,
                                             DefaultQueryForm defaultQueryForm)
                                      throws WTException

Supported API: false

Parameters:

node -

defaultQueryForm -

Returns:

NodeQueryForm

Throws:

WTException

initialize

protected void initialize(AbstractNode node,
                          DefaultQueryForm defaultQueryForm)
                   throws WTException

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

Supported API: false

Parameters:

node -

defaultQueryForm -

Throws:

WTException

newNodeQueryForm

public static NodeQueryForm newNodeQueryForm()
                                      throws WTException

Supported API: false

Returns:

NodeQueryForm

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 AbstractQueryForm

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 AbstractQueryForm

Returns:

int