wt.workflow.notebook
Class NotebookFolder

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

All Implemented Interfaces:

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

public class NotebookFolder

extends NotebookComponent

implements CollaborationContainer, Externalizable

Use the newNotebookFolder static factory method(s), not the NotebookFolder 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 String	DEFINITION Label for the attribute.
private ObjectReference	definitionReference
private String	description
static String	DESCRIPTION Label for the attribute.
private static int	DESCRIPTION_UPPER_LIMIT
private WTStringSet	eventSet
static long	EXTERNALIZATION_VERSION_UID
private boolean	hotlist
static String	HOTLIST Label for the attribute.
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
static String	PARENT_FOLDER Label for the attribute.
static String	PARENT_FOLDER_REFERENCE Label for the attribute.
private ObjectReference	parentFolderReference
private static String	RESOURCE
(package private) static long	serialVersionUID
private static boolean	VERBOSE

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.workflow.collaboration.CollaborationContainer

DEFINITION_REFERENCE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

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

NotebookFolder()

Method Summary

private void	definitionReferenceValidate(ObjectReference a_DefinitionReference)
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.
Enumeration	getBookmarks() Supported API: false
Vector	getChildren() Returns all objects that have the container as their parent object.
String	getConceptualClassname() Deprecated.
CollaborationTemplate	getDefinition() Gets the object for the association that plays role: DEFINITION.
ObjectReference	getDefinitionReference() Gets the value of the attribute: DEFINITION_REFERENCE.
int	getDepthLevel(NotebookFolder aFolder)
String	getDescription() Gets the value of the attribute: DESCRIPTION.
WTStringSet	getEventSet() Gets the value of the attribute: EVENT_SET.
Enumeration	getFolders() Supported API: false
Notebook	getNotebook() Gets the object for the association that plays role: NOTEBOOK.
ObjectReference	getNotebookReference() Gets the value of the attribute: NOTEBOOK_REFERENCE.
CollaborationContainer	getParent() Returns the object if any that acts as the container of this object.
NotebookFolder	getParentFolder() Gets the object for the association that plays role: PARENT_FOLDER.
ObjectReference	getParentFolderReference() Gets the value of the attribute: PARENT_FOLDER_REFERENCE.
QueryResult	getQR_Bookmarks()
QueryResult	getQR_Folders()
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String folderName, CollaborationContainer parent) Supports initialization, following construction of an instance.
boolean	isHotlist() Gets the value of the attribute: HOTLIST.
static NotebookFolder	newNotebookFolder(String folderName, CollaborationContainer parent) Supported API: false
private void	notebookReferenceValidate(ObjectReference a_NotebookReference)
private void	parentFolderReferenceValidate(ObjectReference a_ParentFolderReference)
ObjectSubscription	populateSubscription(ObjectSubscription subscription) Populates the given ObjectSubscription with values specific to the CollaborationContainer object.
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(NotebookFolder thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDefinition(CollaborationTemplate a_Definition) Sets the object for the association that plays role: DEFINITION.
void	setDefinitionReference(ObjectReference a_DefinitionReference) Sets the value of the attribute: DEFINITION_REFERENCE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setEventSet(WTStringSet a_EventSet) Sets the value of the attribute: EVENT_SET.
void	setHotlist(boolean a_Hotlist) Sets the value of the attribute: HOTLIST.
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	setParentFolder(NotebookFolder a_ParentFolder) Sets the object for the association that plays role: PARENT_FOLDER.
void	setParentFolderReference(ObjectReference a_ParentFolderReference) Sets the value of the attribute: PARENT_FOLDER_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.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

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

HOTLIST

public static final String HOTLIST

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

hotlist

private boolean hotlist

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

PARENT_FOLDER

public static final String PARENT_FOLDER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

PARENT_FOLDER_REFERENCE

public static final String PARENT_FOLDER_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

parentFolderReference

private ObjectReference parentFolderReference

DEFINITION

public static final String DEFINITION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

definitionReference

private ObjectReference definitionReference

eventSet

private WTStringSet eventSet

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

VERBOSE

private static final boolean VERBOSE

Constructor Detail

NotebookFolder

public NotebookFolder()

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

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

isHotlist

public boolean isHotlist()

Gets the value of the attribute: HOTLIST.

Supported API: false

Returns:

boolean

setHotlist

public void setHotlist(boolean a_Hotlist)
                throws WTPropertyVetoException

Sets the value of the attribute: HOTLIST.

Supported API: false

Parameters:

a_Hotlist -

Throws:

WTPropertyVetoException

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 WTPropertyVetoException,
                        WTException

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

Supported API: false

Parameters:

a_Notebook -

Throws:

WTPropertyVetoException

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)
                          throws WTPropertyVetoException

Sets the value of the attribute: NOTEBOOK_REFERENCE.

Supported API: false

Parameters:

a_NotebookReference -

Throws:

WTPropertyVetoException

notebookReferenceValidate

private void notebookReferenceValidate(ObjectReference a_NotebookReference)
                                throws WTPropertyVetoException

Parameters:

a_NotebookReference -

Throws:

WTPropertyVetoException

getParentFolder

public NotebookFolder getParentFolder()

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

Supported API: false

Returns:

NotebookFolder

setParentFolder

public void setParentFolder(NotebookFolder a_ParentFolder)
                     throws WTPropertyVetoException,
                            WTException

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

Supported API: false

Parameters:

a_ParentFolder -

Throws:

WTPropertyVetoException

WTException

getParentFolderReference

public ObjectReference getParentFolderReference()

Gets the value of the attribute: PARENT_FOLDER_REFERENCE.

Supported API: false

Returns:

ObjectReference

setParentFolderReference

public void setParentFolderReference(ObjectReference a_ParentFolderReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: PARENT_FOLDER_REFERENCE.

Supported API: false

Parameters:

a_ParentFolderReference -

Throws:

WTPropertyVetoException

parentFolderReferenceValidate

private void parentFolderReferenceValidate(ObjectReference a_ParentFolderReference)
                                    throws WTPropertyVetoException

Parameters:

a_ParentFolderReference -

Throws:

WTPropertyVetoException

newNotebookFolder

public static NotebookFolder newNotebookFolder(String folderName,
                                               CollaborationContainer parent)
                                        throws WTException

Supported API: false

Parameters:

folderName -

parent -

Returns:

NotebookFolder

Throws:

WTException

initialize

protected void initialize(String folderName,
                          CollaborationContainer parent)
                   throws WTException

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

Supported API: false

Parameters:

folderName -

parent -

Throws:

WTException

getFolders

public Enumeration getFolders()
                       throws WTException

Supported API: false

Returns:

Enumeration

Throws:

WTException

getBookmarks

public Enumeration getBookmarks()
                         throws WTException

Supported API: false

Returns:

Enumeration

Throws:

WTException

getChildren

public Vector getChildren()
                   throws WTException

Returns all objects that have the container as their parent object.

Supported API: false

Specified by:

getChildren in interface CollaborationContainer

Returns:

Vector

Throws:

WTException

getParent

public CollaborationContainer getParent()
                                 throws WTException

Returns the object if any that acts as the container of this object.

Supported API: false

Specified by:

getParent in interface CollaborationContainer

Returns:

CollaborationContainer

Throws:

WTException

populateSubscription

public ObjectSubscription populateSubscription(ObjectSubscription subscription)
                                        throws WTException

Populates the given ObjectSubscription with values specific to the CollaborationContainer object.

Supported API: false

Specified by:

populateSubscription in interface CollaborationContainer

Parameters:

subscription -

Returns:

ObjectSubscription

Throws:

WTException

getDefinition

public CollaborationTemplate getDefinition()

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

Supported API: false

Specified by:

getDefinition in interface CollaborationContainer

Returns:

CollaborationTemplate

setDefinition

public void setDefinition(CollaborationTemplate a_Definition)
                   throws WTPropertyVetoException,
                          WTException

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

Supported API: false

Specified by:

setDefinition in interface CollaborationContainer

Parameters:

a_Definition -

Throws:

WTPropertyVetoException

WTException

getDefinitionReference

public ObjectReference getDefinitionReference()

Gets the value of the attribute: DEFINITION_REFERENCE.

Supported API: false

Specified by:

getDefinitionReference in interface CollaborationContainer

Returns:

ObjectReference

setDefinitionReference

public void setDefinitionReference(ObjectReference a_DefinitionReference)
                            throws WTPropertyVetoException

Sets the value of the attribute: DEFINITION_REFERENCE.

Supported API: false

Specified by:

setDefinitionReference in interface CollaborationContainer

Parameters:

a_DefinitionReference -

Throws:

WTPropertyVetoException

definitionReferenceValidate

private void definitionReferenceValidate(ObjectReference a_DefinitionReference)
                                  throws WTPropertyVetoException

Parameters:

a_DefinitionReference -

Throws:

WTPropertyVetoException

getEventSet

public WTStringSet getEventSet()

Gets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

getEventSet in interface Notifiable

Returns:

WTStringSet

setEventSet

public void setEventSet(WTStringSet a_EventSet)

Sets the value of the attribute: EVENT_SET. Sets of events for which the object has a subscriber.

Supported API: false

Specified by:

setEventSet in interface Notifiable

Parameters:

a_EventSet -

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

getQR_Folders

public QueryResult getQR_Folders()
                          throws WTException

Throws:

WTException

getQR_Bookmarks

public QueryResult getQR_Bookmarks()
                            throws WTException

Throws:

WTException

getDepthLevel

public int getDepthLevel(NotebookFolder aFolder)
                  throws WTException

Throws:

WTException