wt.csm.navigation
Class IndirectQueryTarget

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

public class IndirectQueryTarget
extends AbstractQueryTarget
implements Externalizable

Use the newIndirectQueryTarget static factory method(s), not the IndirectQueryTarget 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 long EXTERNALIZATION_VERSION_UID
           
static String NAV_STRUCT
          Label for the attribute.
static String NAV_STRUCT_REFERENCE
          Label for the attribute.
private  ObjectReference navStructReference
           
protected static long OLD_FORMAT_VERSION_UID
           
static String REF_DEF
          Label for the attribute.
static String REF_DEF_REFERENCE
          Label for the attribute.
private  ObjectReference refDefReference
           
private static String RESOURCE
           
(package private) static long serialVersionUID
           
 
Fields inherited from class wt.csm.navigation.AbstractQueryTarget
DEFAULT_QUERY_FORM, DEFAULT_QUERY_FORM_REFERENCE, LABEL
 
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
IndirectQueryTarget()
           
 
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.  
 AbstractNavStruct getNavStruct()
          Gets the object for the association that plays role: NAV_STRUCT.
 ObjectReference getNavStructReference()
          Gets the value of the attribute: NAV_STRUCT_REFERENCE.
 ReferenceDefinition getRefDef()
          Gets the object for the association that plays role: REF_DEF.
 ObjectReference getRefDefReference()
          Gets the value of the attribute: REF_DEF_REFERENCE.
 int hashCode()
          Returns a hash code for this object based upon its ObjectIdentifier.
protected  void initialize(String label, ReferenceDefinition referenceDef, AbstractNavStruct navStruct)
          Supports initialization, following construction of an instance.
private  void navStructReferenceValidate(ObjectReference a_NavStructReference)
           
static IndirectQueryTarget newIndirectQueryTarget()
          

Supported API: false
static IndirectQueryTarget newIndirectQueryTarget(String label, ReferenceDefinition referenceDef, AbstractNavStruct navStruct)
          

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(IndirectQueryTarget thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone)
          Reads the non-transient fields of this class from an external source.
private  void refDefReferenceValidate(ObjectReference a_RefDefReference)
           
 void setNavStruct(AbstractNavStruct a_NavStruct)
          Sets the object for the association that plays role: NAV_STRUCT.
 void setNavStructReference(ObjectReference a_NavStructReference)
          Sets the value of the attribute: NAV_STRUCT_REFERENCE.
 void setRefDef(ReferenceDefinition a_RefDef)
          Sets the object for the association that plays role: REF_DEF.
 void setRefDefReference(ObjectReference a_RefDefReference)
          Sets the value of the attribute: REF_DEF_REFERENCE.
 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.AbstractQueryTarget
getDefaultQueryForm, getDefaultQueryFormReference, getLabel, readVersion, setDefaultQueryForm, setDefaultQueryFormReference, setLabel
 
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

REF_DEF

public static final String REF_DEF
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

REF_DEF_REFERENCE

public static final String REF_DEF_REFERENCE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

refDefReference

private ObjectReference refDefReference

NAV_STRUCT

public static final String NAV_STRUCT
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

NAV_STRUCT_REFERENCE

public static final String NAV_STRUCT_REFERENCE
Label for the attribute.

Supported API: false

See Also:
Constant Field Values

navStructReference

private ObjectReference navStructReference

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

IndirectQueryTarget

public IndirectQueryTarget()
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 AbstractQueryTarget
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 AbstractQueryTarget
Parameters:
input -
Throws:
IOException
ClassNotFoundException

readVersion

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

getRefDef

public ReferenceDefinition getRefDef()
Gets the object for the association that plays role: REF_DEF.

Supported API: false

Returns:
ReferenceDefinition

setRefDef

public void setRefDef(ReferenceDefinition a_RefDef)
               throws WTPropertyVetoException,
                      WTException
Sets the object for the association that plays role: REF_DEF.

Supported API: false

Parameters:
a_RefDef -
Throws:
WTPropertyVetoException
WTException

getRefDefReference

public ObjectReference getRefDefReference()
Gets the value of the attribute: REF_DEF_REFERENCE.

Supported API: false

Returns:
ObjectReference

setRefDefReference

public void setRefDefReference(ObjectReference a_RefDefReference)
                        throws WTPropertyVetoException
Sets the value of the attribute: REF_DEF_REFERENCE.

Supported API: false

Parameters:
a_RefDefReference -
Throws:
WTPropertyVetoException

refDefReferenceValidate

private void refDefReferenceValidate(ObjectReference a_RefDefReference)
                              throws WTPropertyVetoException
Parameters:
a_RefDefReference -
Throws:
WTPropertyVetoException

getNavStruct

public AbstractNavStruct getNavStruct()
Gets the object for the association that plays role: NAV_STRUCT.

Supported API: false

Returns:
AbstractNavStruct

setNavStruct

public void setNavStruct(AbstractNavStruct a_NavStruct)
                  throws WTPropertyVetoException,
                         WTException
Sets the object for the association that plays role: NAV_STRUCT.

Supported API: false

Parameters:
a_NavStruct -
Throws:
WTPropertyVetoException
WTException

getNavStructReference

public ObjectReference getNavStructReference()
Gets the value of the attribute: NAV_STRUCT_REFERENCE.

Supported API: false

Returns:
ObjectReference

setNavStructReference

public void setNavStructReference(ObjectReference a_NavStructReference)
                           throws WTPropertyVetoException
Sets the value of the attribute: NAV_STRUCT_REFERENCE.

Supported API: false

Parameters:
a_NavStructReference -
Throws:
WTPropertyVetoException

navStructReferenceValidate

private void navStructReferenceValidate(ObjectReference a_NavStructReference)
                                 throws WTPropertyVetoException
Parameters:
a_NavStructReference -
Throws:
WTPropertyVetoException

newIndirectQueryTarget

public static IndirectQueryTarget newIndirectQueryTarget()
                                                  throws WTException


Supported API: false

Returns:
IndirectQueryTarget
Throws:
WTException

newIndirectQueryTarget

public static IndirectQueryTarget newIndirectQueryTarget(String label,
                                                         ReferenceDefinition referenceDef,
                                                         AbstractNavStruct navStruct)
                                                  throws WTException


Supported API: false

Parameters:
label -
referenceDef -
navStruct -
Returns:
IndirectQueryTarget
Throws:
WTException

initialize

protected void initialize(String label,
                          ReferenceDefinition referenceDef,
                          AbstractNavStruct navStruct)
                   throws WTException
Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:
label -
referenceDef -
navStruct -
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 AbstractQueryTarget
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 AbstractQueryTarget
Returns:
int