wt.csm.navigation
Class AbstractNavStruct

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Simple
          wt.csm.navigation.AbstractNavStruct

All Implemented Interfaces:

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

Direct Known Subclasses:

ClassificationNavStruct, IndependentNavStruct

public abstract class AbstractNavStruct

extends Simple

implements Externalizable

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	DIRECT_QUERY_TARGET Label for the attribute.
static String	DIRECT_QUERY_TARGET_REFERENCE Label for the attribute.
static long	EXTERNALIZATION_VERSION_UID
private String	name
static String	NAME Label for the attribute.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SHOW_ALL_ATTRIBUTES Label for the attribute.
static String	SHOW_GRAPHICAL_TAB Label for the attribute.
private boolean	showAllAttributes
private boolean	showGraphicalTab
private ObjectReference	theDirectQueryTargetReference

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

AbstractNavStruct()

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.
DirectQueryTarget	getDirectQueryTarget() Gets the object for the association that plays role: DIRECT_QUERY_TARGET.
ObjectReference	getDirectQueryTargetReference() Gets the value of the attribute: DIRECT_QUERY_TARGET_REFERENCE.
String	getName() Gets the value of the attribute: NAME.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	isShowAllAttributes() Gets the value of the attribute: SHOW_ALL_ATTRIBUTES.
boolean	isShowGraphicalTab() Gets the value of the attribute: SHOW_GRAPHICAL_TAB.
private void	nameValidate(String a_Name)
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(AbstractNavStruct thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDirectQueryTarget(DirectQueryTarget a_DirectQueryTarget) Sets the object for the association that plays role: DIRECT_QUERY_TARGET.
void	setDirectQueryTargetReference(ObjectReference a_DirectQueryTargetReference) Sets the value of the attribute: DIRECT_QUERY_TARGET_REFERENCE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setShowAllAttributes(boolean a_ShowAllAttributes) Sets the value of the attribute: SHOW_ALL_ATTRIBUTES.
void	setShowGraphicalTab(boolean a_ShowGraphicalTab) Sets the value of the attribute: SHOW_GRAPHICAL_TAB.
private void	theDirectQueryTargetReferenceValidate(ObjectReference a_DirectQueryTargetReference)
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

NAME

public static final String NAME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

SHOW_GRAPHICAL_TAB

public static final String SHOW_GRAPHICAL_TAB

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

showGraphicalTab

private boolean showGraphicalTab

SHOW_ALL_ATTRIBUTES

public static final String SHOW_ALL_ATTRIBUTES

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

showAllAttributes

private boolean showAllAttributes

DIRECT_QUERY_TARGET

public static final String DIRECT_QUERY_TARGET

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DIRECT_QUERY_TARGET_REFERENCE

public static final String DIRECT_QUERY_TARGET_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

theDirectQueryTargetReference

private ObjectReference theDirectQueryTargetReference

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

AbstractNavStruct

public AbstractNavStruct()

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(AbstractNavStruct 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

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

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

isShowGraphicalTab

public boolean isShowGraphicalTab()

Gets the value of the attribute: SHOW_GRAPHICAL_TAB.

Supported API: false

Returns:

boolean

setShowGraphicalTab

public void setShowGraphicalTab(boolean a_ShowGraphicalTab)
                         throws WTPropertyVetoException

Sets the value of the attribute: SHOW_GRAPHICAL_TAB.

Supported API: false

Parameters:

a_ShowGraphicalTab -

Throws:

WTPropertyVetoException

isShowAllAttributes

public boolean isShowAllAttributes()

Gets the value of the attribute: SHOW_ALL_ATTRIBUTES.

Supported API: false

Returns:

boolean

setShowAllAttributes

public void setShowAllAttributes(boolean a_ShowAllAttributes)
                          throws WTPropertyVetoException

Sets the value of the attribute: SHOW_ALL_ATTRIBUTES.

Supported API: false

Parameters:

a_ShowAllAttributes -

Throws:

WTPropertyVetoException

getDirectQueryTarget

public DirectQueryTarget getDirectQueryTarget()

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

Supported API: false

Returns:

DirectQueryTarget

setDirectQueryTarget

public void setDirectQueryTarget(DirectQueryTarget a_DirectQueryTarget)
                          throws WTPropertyVetoException,
                                 WTException

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

Supported API: false

Parameters:

a_DirectQueryTarget -

Throws:

WTPropertyVetoException

WTException

getDirectQueryTargetReference

public ObjectReference getDirectQueryTargetReference()

Gets the value of the attribute: DIRECT_QUERY_TARGET_REFERENCE.

Supported API: false

Returns:

ObjectReference

setDirectQueryTargetReference

public void setDirectQueryTargetReference(ObjectReference a_DirectQueryTargetReference)
                                   throws WTPropertyVetoException

Sets the value of the attribute: DIRECT_QUERY_TARGET_REFERENCE.

Supported API: false

Parameters:

a_DirectQueryTargetReference -

Throws:

WTPropertyVetoException

theDirectQueryTargetReferenceValidate

private void theDirectQueryTargetReferenceValidate(ObjectReference a_DirectQueryTargetReference)
                                            throws WTPropertyVetoException

Parameters:

a_DirectQueryTargetReference -

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