wt.workflow.notebook
Class WfFolderedBookmark

java.lang.Object
  wt.fc.WTObject
      wt.workflow.notebook.NotebookComponent
          wt.workflow.notebook.Bookmark
              wt.workflow.notebook.FolderedBookmark
                  wt.workflow.notebook.WfFolderedBookmark

All Implemented Interfaces:

CabinetBased, DisplayIdentification, DomainAdministered, Externalizable, Foldered, FolderEntry, FolderServiceManaged, Indexable, NetFactor, ObjectMappable, Ownable, Persistable, RecentlyVisited, Serializable, WTContained

public class WfFolderedBookmark

extends FolderedBookmark

implements Externalizable

A specialization of FolderedBoomark, objects of this type can point to the ObjectIdentifier of Windchill business objects.

Use the newWfFolderedBookmark static factory method(s), not the WfFolderedBookmark 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	OBJECT Label for the attribute.
static String	OBJECT_REFERENCE Label for the attribute.
private ObjectReference	objectReference
private ObjectIdentifier	oid
static String	OID Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

Fields inherited from class wt.workflow.notebook.FolderedBookmark

Fields inherited from class wt.workflow.notebook.Bookmark

CREATOR, DESCRIPTION, FOLDER, FOLDER_REFERENCE, MODIFIER, NOTEBOOK, NOTEBOOK_REFERENCE, URL

Fields inherited from class wt.workflow.notebook.NotebookComponent

CONTAINER, NAME

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

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.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.index.Indexable

INDEXER_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

WfFolderedBookmark()

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.
WTContained	getObject() Gets the object for the association that plays role: OBJECT.
ObjectReference	getObjectReference() Gets the value of the attribute: OBJECT_REFERENCE.
ObjectIdentifier	getOid() Gets the value of the attribute: OID.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name, ObjectReference objectRef) Supports initialization, following construction of an instance.
static WfFolderedBookmark	newWfFolderedBookmark(String name, ObjectReference objectRef) Supported API: false
private void	objectReferenceValidate(ObjectReference a_ObjectReference)
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(WfFolderedBookmark thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setObject(WTContained a_Object) Sets the object for the association that plays role: OBJECT.
void	setObjectReference(ObjectReference a_ObjectReference) Sets the value of the attribute: OBJECT_REFERENCE.
void	setOid(ObjectIdentifier a_Oid) Sets the value of the attribute: OID.
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.workflow.notebook.FolderedBookmark

getCabinet, getCabinetName, getCabinetReference, getFolderingInfo, getFolderPath, getLocation, getName, initialize, newFolderedBookmark, readVersion, setFolderingInfo

Methods inherited from class wt.workflow.notebook.Bookmark

getCreator, getDescription, getFolder, getFolderReference, getModifier, getNotebook, getNotebookReference, getParent, getUrl, initialize, newBookmark, newBookmark, readVersion, setCreator, setDescription, setFolder, setFolderReference, setModifier, setNotebook, setNotebookReference, setUrl

Methods inherited from class wt.workflow.notebook.NotebookComponent

getContainer, getContainerName, getContainerReference, getDomainRef, getIndexerSet, getOwnership, isInheritedDomain, readVersion, setContainer, setContainerReference, setDomainRef, setIndexerSet, setInheritedDomain, setName, setOwnership

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, 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.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.admin.DomainAdministered

getDomainRef, isInheritedDomain, setDomainRef, setInheritedDomain

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

OID

public static final String OID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

oid

private ObjectIdentifier oid

OBJECT

public static final String OBJECT

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

OBJECT_REFERENCE

public static final String OBJECT_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

objectReference

private ObjectReference objectReference

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

WfFolderedBookmark

public WfFolderedBookmark()

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 FolderedBookmark

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 FolderedBookmark

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfFolderedBookmark 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 FolderedBookmark

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 FolderedBookmark

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

Overrides:

getConceptualClassname in class FolderedBookmark

Returns:

String

getOid

public ObjectIdentifier getOid()

Gets the value of the attribute: OID.

Supported API: false

Returns:

ObjectIdentifier

setOid

public void setOid(ObjectIdentifier a_Oid)
            throws WTPropertyVetoException

Sets the value of the attribute: OID.

Supported API: false

Parameters:

a_Oid -

Throws:

WTPropertyVetoException

getObject

public WTContained getObject()

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

Supported API: false

Returns:

WTContained

setObject

public void setObject(WTContained a_Object)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: false

Parameters:

a_Object -

Throws:

WTPropertyVetoException

WTException

getObjectReference

public ObjectReference getObjectReference()

Gets the value of the attribute: OBJECT_REFERENCE.

Supported API: false

Returns:

ObjectReference

setObjectReference

public void setObjectReference(ObjectReference a_ObjectReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: OBJECT_REFERENCE.

Supported API: false

Parameters:

a_ObjectReference -

Throws:

WTPropertyVetoException

objectReferenceValidate

private void objectReferenceValidate(ObjectReference a_ObjectReference)
                              throws WTPropertyVetoException

Parameters:

a_ObjectReference -

Throws:

WTPropertyVetoException

newWfFolderedBookmark

public static WfFolderedBookmark newWfFolderedBookmark(String name,
                                                       ObjectReference objectRef)
                                                throws WTException

Supported API: false

Parameters:

name -

objectRef -

Returns:

WfFolderedBookmark

Throws:

WTException

initialize

protected void initialize(String name,
                          ObjectReference objectRef)
                   throws WTException

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

Supported API: false

Parameters:

name -

objectRef -

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 FolderedBookmark

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 FolderedBookmark

Returns:

int