wt.folder
Class ShortcutLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.folder.ShortcutLink

All Implemented Interfaces:

BinaryLink, CabinetBased, DisplayIdentification, Externalizable, FolderEntry, FolderEntryLink, FolderServiceManaged, Link, NetFactor, ObjectMappable, Persistable, Serializable, Shortcut

public final class ShortcutLink

extends ObjectToObjectLink

implements Shortcut, Externalizable

A persistent assocation between a Folder and a non-iterated CabinetBased object. The association class implements the Shortcut interface.

Use the newShortcutLink static factory method(s), not the ShortcutLink 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: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
static String	REFERENCING_FOLDER_ROLE Label for the attribute; The referencingFolder role object is the folder that contains the Shortcut.
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	TARGET_ROLE Label for the attribute; The target of the association is the object which appears as a Shortcut member of a folder.

Fields inherited from class wt.fc.ObjectToObjectLink

ROLE_AOBJECT_REF, ROLE_BOBJECT_REF

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION, NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.fc.BinaryLink

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_REF, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_REF, ROLE_BOBJECT_ROLE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

ShortcutLink()

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.
CabinetReference	getCabinetReference() Gets the value of the attribute: CABINET_REFERENCE.
String	getConceptualClassname() Deprecated.
FolderEntry	getEntry() Supported API: false
Folder	getFolder() Supported API: false
String	getFolderPath() Gets the value of the attribute: FOLDER_PATH.
String	getLocation() Gets the value of the attribute: LOCATION.
String	getName() Gets the value of the attribute: NAME.
Folder	getReferencingFolder() Gets the object for the association that plays role: REFERENCING_FOLDER_ROLE.
CabinetBased	getTarget() Gets the object for the association that plays role: TARGET_ROLE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static ShortcutLink	newShortcutLink(Folder referencingFolder, CabinetBased target) Default factory for the class.
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(ShortcutLink thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setFolder(Folder folder) Supported API: false
void	setReferencingFolder(Folder folder) Sets the object for the association that plays role: REFERENCING_FOLDER_ROLE.
void	setTarget(CabinetBased target) Sets the object for the association that plays role: TARGET_ROLE.
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.fc.ObjectToObjectLink

appendJoinCriteria, appendRoleCriteria, duplicate, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRemoteRoleAObjectId, getRemoteRoleBObjectId, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, initialize, isRoleANonpersistentProxy, isRoleBNonpersistentProxy, readVersion, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef, setRoleObject

Methods inherited from class wt.fc.WTObject

checkAttributes, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.fc.BinaryLink

getLinkInfo, getObject, getOtherObject, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef

Methods inherited from interface wt.fc.Link

appendJoinCriteria, appendRoleCriteria, getAllObjects, getJoinValues, getRoleIdName, getRoleObject, setRoleObject

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

REFERENCING_FOLDER_ROLE

public static final String REFERENCING_FOLDER_ROLE

Label for the attribute; The referencingFolder role object is the folder that contains the Shortcut.

Supported API: false

See Also:

Constant Field Values

TARGET_ROLE

public static final String TARGET_ROLE

Label for the attribute; The target of the association is the object which appears as a Shortcut member of a folder.

Supported API: false

See Also:

Constant Field Values

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

ShortcutLink

public ShortcutLink()

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 ObjectToObjectLink

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 ObjectToObjectLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ShortcutLink 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 ObjectToObjectLink

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 ObjectToObjectLink

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

newShortcutLink

public static ShortcutLink newShortcutLink(Folder referencingFolder,
                                           CabinetBased target)
                                    throws WTException

Default factory for the class.

Supported API: false

Parameters:

referencingFolder -

target -

Returns:

ShortcutLink

Throws:

WTException

getName

public String getName()

Gets the value of the attribute: NAME. A name for the information. This name becomes a component of the full path of the object. The name is derived from the object itself.

Supported API: false

Specified by:

getName in interface CabinetBased

Returns:

String

getFolderPath

public String getFolderPath()

Gets the value of the attribute: FOLDER_PATH. The complete path for the object. The path includes the location with the name appended. This information is calculated.

Supported API: false

Specified by:

getFolderPath in interface CabinetBased

Returns:

String

getLocation

public String getLocation()

Gets the value of the attribute: LOCATION. The location, described as a path for the object. The location does not include the object's name, but rather indicates what Folder (Cabinet or SubFolder) that the object resides in. This information is calculated.

Supported API: false

Specified by:

getLocation in interface CabinetBased

Returns:

String

getCabinetReference

public CabinetReference getCabinetReference()

Gets the value of the attribute: CABINET_REFERENCE. A reference to the cabinet that the entry is consided part of.

Supported API: false

Specified by:

getCabinetReference in interface CabinetBased

Returns:

CabinetReference

getFolder

public Folder getFolder()

Supported API: false

Specified by:

getFolder in interface FolderEntryLink

Returns:

Folder

setFolder

public void setFolder(Folder folder)

Supported API: false

Specified by:

setFolder in interface FolderEntryLink

Parameters:

folder -

getEntry

public FolderEntry getEntry()

Supported API: false

Specified by:

getEntry in interface FolderEntryLink

Returns:

FolderEntry

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 ObjectToObjectLink

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 ObjectToObjectLink

Returns:

int

getTarget

public CabinetBased getTarget()

Description copied from interface: Shortcut

Gets the object for the association that plays role: TARGET_ROLE. The target of the association is the object which appears as a Shortcut member of a folder.

Supported API: false

Specified by:

getTarget in interface Shortcut

Returns:

CabinetBased

setTarget

public void setTarget(CabinetBased target)

Description copied from interface: Shortcut

Sets the object for the association that plays role: TARGET_ROLE. The target of the association is the object which appears as a Shortcut member of a folder.

Supported API: false

Specified by:

setTarget in interface Shortcut

Parameters:

target -

getReferencingFolder

public Folder getReferencingFolder()

Description copied from interface: Shortcut

Gets the object for the association that plays role: REFERENCING_FOLDER_ROLE. The referencingFolder role object is the folder that contains the Shortcut.

Supported API: false

Specified by:

getReferencingFolder in interface Shortcut

Returns:

Folder

setReferencingFolder

public void setReferencingFolder(Folder folder)

Description copied from interface: Shortcut

Sets the object for the association that plays role: REFERENCING_FOLDER_ROLE. The referencingFolder role object is the folder that contains the Shortcut.

Supported API: false

Specified by:

setReferencingFolder in interface Shortcut

Parameters:

folder -