wt.csm.navigation
Class AbstractQueryTarget

java.lang.Object
  extended bywt.fc.WTObject
      extended bywt.enterprise.Simple
          extended bywt.csm.navigation.AbstractQueryTarget
All Implemented Interfaces:
AccessControlled, BusinessInformation, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, Notifiable, ObjectMappable, Persistable, Serializable
Direct Known Subclasses:
DirectQueryTarget, IndirectQueryTarget

public abstract class AbstractQueryTarget
extends Simple
implements Externalizable



Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
static String DEFAULT_QUERY_FORM
          Label for the attribute.
static String DEFAULT_QUERY_FORM_REFERENCE
          Label for the attribute.
static long EXTERNALIZATION_VERSION_UID
           
private  String label
           
static String LABEL
          Label for the attribute.
private static int LABEL_UPPER_LIMIT
           
protected static long OLD_FORMAT_VERSION_UID
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
private  ObjectReference theDefaultQueryFormReference
           
 
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
AbstractQueryTarget()
           
 
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.
 DefaultQueryForm getDefaultQueryForm()
          Gets the object for the association that plays role: DEFAULT_QUERY_FORM.
 ObjectReference getDefaultQueryFormReference()
          Gets the value of the attribute: DEFAULT_QUERY_FORM_REFERENCE.
 String getLabel()
          Gets the value of the attribute: LABEL.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
private  void labelValidate(String a_Label)
           
 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(AbstractQueryTarget thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
 void setDefaultQueryForm(DefaultQueryForm a_DefaultQueryForm)
          Sets the object for the association that plays role: DEFAULT_QUERY_FORM.
 void setDefaultQueryFormReference(ObjectReference a_DefaultQueryFormReference)
          Sets the value of the attribute: DEFAULT_QUERY_FORM_REFERENCE.
 void setLabel(String a_Label)
          Sets the value of the attribute: LABEL.
private  void theDefaultQueryFormReferenceValidate(ObjectReference a_DefaultQueryFormReference)
           
 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.NetFactor
getClassInfo, getConceptualClassname
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

LABEL

public static final String LABEL
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

LABEL_UPPER_LIMIT

private static int LABEL_UPPER_LIMIT

label

private String label

DEFAULT_QUERY_FORM

public static final String DEFAULT_QUERY_FORM
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

DEFAULT_QUERY_FORM_REFERENCE

public static final String DEFAULT_QUERY_FORM_REFERENCE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

theDefaultQueryFormReference

private ObjectReference theDefaultQueryFormReference

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

AbstractQueryTarget

public AbstractQueryTarget()
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(AbstractQueryTarget 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

getLabel

public String getLabel()
Gets the value of the attribute: LABEL.

Supported API: false

Returns:
String

setLabel

public void setLabel(String a_Label)
              throws WTPropertyVetoException
Sets the value of the attribute: LABEL.

Supported API: false

Parameters:
a_Label -
Throws:
WTPropertyVetoException

labelValidate

private void labelValidate(String a_Label)
                    throws WTPropertyVetoException
Parameters:
a_Label -
Throws:
WTPropertyVetoException

getDefaultQueryForm

public DefaultQueryForm getDefaultQueryForm()
Gets the object for the association that plays role: DEFAULT_QUERY_FORM.

Supported API: false

Returns:
DefaultQueryForm

setDefaultQueryForm

public void setDefaultQueryForm(DefaultQueryForm a_DefaultQueryForm)
                         throws WTPropertyVetoException,
                                WTException
Sets the object for the association that plays role: DEFAULT_QUERY_FORM.

Supported API: false

Parameters:
a_DefaultQueryForm -
Throws:
WTPropertyVetoException
WTException

getDefaultQueryFormReference

public ObjectReference getDefaultQueryFormReference()
Gets the value of the attribute: DEFAULT_QUERY_FORM_REFERENCE.

Supported API: false

Returns:
ObjectReference

setDefaultQueryFormReference

public void setDefaultQueryFormReference(ObjectReference a_DefaultQueryFormReference)
                                  throws WTPropertyVetoException
Sets the value of the attribute: DEFAULT_QUERY_FORM_REFERENCE.

Supported API: false

Parameters:
a_DefaultQueryFormReference -
Throws:
WTPropertyVetoException

theDefaultQueryFormReferenceValidate

private void theDefaultQueryFormReferenceValidate(ObjectReference a_DefaultQueryFormReference)
                                           throws WTPropertyVetoException
Parameters:
a_DefaultQueryFormReference -
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