wt.workflow.notebook
Class Bookmark

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

All Implemented Interfaces:

DisplayIdentification, DomainAdministered, Externalizable, Indexable, NetFactor, ObjectMappable, Ownable, Persistable, RecentlyVisited, Serializable, WTContained

Direct Known Subclasses:

FolderedBookmark, ImportedBookmark, WfBookmark

public class Bookmark

extends NotebookComponent

implements Externalizable

Use the newBookmark static factory method(s), not the Bookmark 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
private WTPrincipalReference	creator
static String	CREATOR Label for the attribute; The creator of the bookmark.
private String	description
static String	DESCRIPTION Label for the attribute.
private static int	DESCRIPTION_UPPER_LIMIT
static long	EXTERNALIZATION_VERSION_UID
static String	FOLDER Label for the attribute.
static String	FOLDER_REFERENCE Label for the attribute.
private ObjectReference	folderReference
private WTPrincipalReference	modifier
static String	MODIFIER Label for the attribute; The modifier of the bookmark.
static String	NOTEBOOK Label for the attribute.
static String	NOTEBOOK_REFERENCE Label for the attribute.
private ObjectReference	notebookReference
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private URL	url
static String	URL Label for the attribute.

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.ownership.Ownable

OWNERSHIP

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

Bookmark()

Method Summary

private void	creatorValidate(WTPrincipalReference a_Creator)
private void	descriptionValidate(String a_Description)
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.
WTPrincipalReference	getCreator() Gets the object for the association that plays role: CREATOR.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
NotebookFolder	getFolder() Gets the object for the association that plays role: FOLDER.
ObjectReference	getFolderReference() Gets the value of the attribute: FOLDER_REFERENCE.
WTPrincipalReference	getModifier() Gets the object for the association that plays role: MODIFIER.
Notebook	getNotebook() Gets the object for the association that plays role: NOTEBOOK.
ObjectReference	getNotebookReference() Gets the value of the attribute: NOTEBOOK_REFERENCE.
CollaborationContainer	getParent()
URL	getUrl() Gets the value of the attribute: URL.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String name, URL url, CollaborationContainer parent) Supports initialization, following construction of an instance.
private void	modifierValidate(WTPrincipalReference a_Modifier)
static Bookmark	newBookmark() Supported API: false
static Bookmark	newBookmark(String name, URL url, CollaborationContainer parent) 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(Bookmark thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCreator(WTPrincipalReference a_Creator) Sets the object for the association that plays role: CREATOR.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setFolder(NotebookFolder a_Folder) Sets the object for the association that plays role: FOLDER.
void	setFolderReference(ObjectReference a_FolderReference) Sets the value of the attribute: FOLDER_REFERENCE.
void	setModifier(WTPrincipalReference a_Modifier) Sets the object for the association that plays role: MODIFIER.
void	setNotebook(Notebook a_Notebook) Sets the object for the association that plays role: NOTEBOOK.
void	setNotebookReference(ObjectReference a_NotebookReference) Sets the value of the attribute: NOTEBOOK_REFERENCE.
void	setUrl(URL a_Url) Sets the value of the attribute: URL.
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.NotebookComponent

getContainer, getContainerName, getContainerReference, getDomainRef, getIndexerSet, getName, 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, 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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

URL

public static final String URL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

url

private URL url

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

FOLDER

public static final String FOLDER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

FOLDER_REFERENCE

public static final String FOLDER_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

folderReference

private ObjectReference folderReference

NOTEBOOK

public static final String NOTEBOOK

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

NOTEBOOK_REFERENCE

public static final String NOTEBOOK_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

notebookReference

private ObjectReference notebookReference

CREATOR

public static final String CREATOR

Label for the attribute; The creator of the bookmark.

Supported API: false

See Also:

Constant Field Values

creator

private WTPrincipalReference creator

MODIFIER

public static final String MODIFIER

Label for the attribute; The modifier of the bookmark.

Supported API: false

See Also:

Constant Field Values

modifier

private WTPrincipalReference modifier

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

Bookmark

public Bookmark()

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 NotebookComponent

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 NotebookComponent

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(Bookmark 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 NotebookComponent

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 NotebookComponent

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

getUrl

public URL getUrl()

Gets the value of the attribute: URL.

Supported API: false

Returns:

URL

setUrl

public void setUrl(URL a_Url)
            throws WTPropertyVetoException

Sets the value of the attribute: URL.

Supported API: false

Parameters:

a_Url -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION.

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getFolder

public NotebookFolder getFolder()

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

Supported API: false

Returns:

NotebookFolder

setFolder

public void setFolder(NotebookFolder a_Folder)
               throws WTException

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

Supported API: false

Parameters:

a_Folder -

Throws:

WTException

getFolderReference

public ObjectReference getFolderReference()

Gets the value of the attribute: FOLDER_REFERENCE.

Supported API: false

Returns:

ObjectReference

setFolderReference

public void setFolderReference(ObjectReference a_FolderReference)

Sets the value of the attribute: FOLDER_REFERENCE.

Supported API: false

Parameters:

a_FolderReference -

getNotebook

public Notebook getNotebook()

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

Supported API: false

Returns:

Notebook

setNotebook

public void setNotebook(Notebook a_Notebook)
                 throws WTException

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

Supported API: false

Parameters:

a_Notebook -

Throws:

WTException

getNotebookReference

public ObjectReference getNotebookReference()

Gets the value of the attribute: NOTEBOOK_REFERENCE.

Supported API: false

Returns:

ObjectReference

setNotebookReference

public void setNotebookReference(ObjectReference a_NotebookReference)

Sets the value of the attribute: NOTEBOOK_REFERENCE.

Supported API: false

Parameters:

a_NotebookReference -

getCreator

public WTPrincipalReference getCreator()

Gets the object for the association that plays role: CREATOR. The creator of the bookmark.

Supported API: false

Returns:

WTPrincipalReference

setCreator

public void setCreator(WTPrincipalReference a_Creator)
                throws WTPropertyVetoException

Sets the object for the association that plays role: CREATOR. The creator of the bookmark.

Supported API: false

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

creatorValidate

private void creatorValidate(WTPrincipalReference a_Creator)
                      throws WTPropertyVetoException

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

getModifier

public WTPrincipalReference getModifier()

Gets the object for the association that plays role: MODIFIER. The modifier of the bookmark.

Supported API: false

Returns:

WTPrincipalReference

setModifier

public void setModifier(WTPrincipalReference a_Modifier)
                 throws WTPropertyVetoException

Sets the object for the association that plays role: MODIFIER. The modifier of the bookmark.

Supported API: false

Parameters:

a_Modifier -

Throws:

WTPropertyVetoException

modifierValidate

private void modifierValidate(WTPrincipalReference a_Modifier)
                       throws WTPropertyVetoException

Parameters:

a_Modifier -

Throws:

WTPropertyVetoException

newBookmark

public static Bookmark newBookmark()
                            throws WTException

Supported API: false

Returns:

Bookmark

Throws:

WTException

newBookmark

public static Bookmark newBookmark(String name,
                                   URL url,
                                   CollaborationContainer parent)
                            throws WTException

Supported API: false

Parameters:

name -

url -

parent -

Returns:

Bookmark

Throws:

WTException

initialize

protected void initialize(String name,
                          URL url,
                          CollaborationContainer parent)
                   throws WTException

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

Supported API: false

Parameters:

name -

url -

parent -

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 NotebookComponent

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 NotebookComponent

Returns:

int

getParent

public CollaborationContainer getParent()
                                 throws WTException

Throws:

WTException