wt.workflow.notebook
Class StandardNotebookService

java.lang.Object
  wt.services.StandardManager
      wt.workflow.notebook.StandardNotebookService

All Implemented Interfaces:

Manager, NetFactor, NotebookService, Serializable

public class StandardNotebookService

extends StandardManager

implements NotebookService, Serializable

Use the newStandardNotebookService static factory method(s), not the StandardNotebookService 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 static String	NOTEBOOKTEMPLATE_NAME
private static String	NOTEBOOKTEMPLATE_XML_FILE
private static int	NRETRIES
private static String	OBJECT_NOTEBOOKTEMPLATE_XML_FILE
private static boolean	PDMLINK
private static String	RESOURCE
private static int	SLEEPTIME
private static boolean	VERBOSE
private static String	WT_HOME
private static String	XML_LOAD_FILE_DIR

Fields inherited from class wt.services.StandardManager

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Constructor Summary

StandardNotebookService()

Method Summary

void	addNotebook(NotebookIfc notebook, SubjectOfNotebook subject, boolean primary) Supported API: false
Notebook	createNotebook(NotebookTemplate template, String name, SubjectOfNotebook subject) Deprecated.
Notebook	createNotebook(NotebookTemplate template, String name, SubjectOfNotebook subject, WTContainerRef containerRef) Supported API: false
Notebook	createNotebook(String templateName, String name, SubjectOfNotebook subject) Deprecated.
Notebook	createNotebookForUser(WTUser user) Supported API: false
void	deleteFolder(NotebookFolder folder) Supported API: false
void	deleteNotebook(Notebook notebook, SubjectOfNotebook subject) Supported API: false
private void	dispatchEvent(String eventType, Object target)
Vector	getAllChildrenOfFolder(NotebookFolder folder)
private Vector	getAllChildrenOfFolder(NotebookFolder pnf, Vector retVec)
ApplicationData	getApplicationData(String file, String tempFile, ContentHolder ctHolder) Supported API: false
Enumeration	getChildren(Notebook notebook) Supported API: false
String	getConceptualClassname() Deprecated.
NotebookTemplate	getDefaultObjectTemplate(boolean isUser) Deprecated.
NotebookTemplate	getDefaultObjectTemplate(boolean isUser, WTContainerRef containerRef) Supported API: false
NotebookTemplate	getDefaultTemplate() Deprecated.
NotebookTemplate	getDefaultTemplate(WTContainerRef containerRef) Supported API: false
NotebookTemplate	getDefaultTemplate(WTObject obj) Deprecated.
NotebookTemplate	getDefaultTemplate(WTObject obj, WTContainerRef containerRef) Supported API: false
Vector	getFolders(CollaborationContainer cc) Supported API: false
private Vector	getFolders(CollaborationContainer cc, Vector retVec)
Enumeration	getNotebooks(WTObject subject) Supported API: false
Enumeration	getNotebooks(WTObject subject, boolean othersideonly) Supported API: false
private static String	getNotebookTemplateStructure(boolean isUser)
NotebookTemplate	getObjectTemplate(WTContainerRef containerRef)
String	getOidString(String url)
private NotebookTemplate	getTemplate(WTContainerRef containerRef)
static StandardNotebookService	newStandardNotebookService() Default factory for the class.
void	propogateDelete(Enumeration childEnum)
private void	registerAsListener()
void	registerEvents(ManagerService managerService) Register events with the passed ManagerService.
Bookmark	saveBookmark(Bookmark bookmark) Supported API: false
NotebookFolder	saveFolder(NotebookFolder folder) Supported API: false
Notebook	saveStructuredReference(SubjectOfNotebook subject, Notebook notebook) Supported API: false
void	saveWindchillBookmark(String name, String s_url, CollaborationContainer parent) Supported API: false

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, performStartupProcess, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

VERBOSE

private static boolean VERBOSE

PDMLINK

private static boolean PDMLINK

NOTEBOOKTEMPLATE_NAME

private static final String NOTEBOOKTEMPLATE_NAME

WT_HOME

private static final String WT_HOME

XML_LOAD_FILE_DIR

private static final String XML_LOAD_FILE_DIR

NOTEBOOKTEMPLATE_XML_FILE

private static final String NOTEBOOKTEMPLATE_XML_FILE

OBJECT_NOTEBOOKTEMPLATE_XML_FILE

private static final String OBJECT_NOTEBOOKTEMPLATE_XML_FILE

NRETRIES

private static final int NRETRIES

See Also:

Constant Field Values

SLEEPTIME

private static final int SLEEPTIME

See Also:

Constant Field Values

Constructor Detail

StandardNotebookService

public StandardNotebookService()

Method Detail

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 StandardManager

Returns:

String

registerEvents

public void registerEvents(ManagerService managerService)

Register events with the passed ManagerService. The default method does nothing, subclasses should provide an overriding implementation.

Supported API: false

Specified by:

registerEvents in interface Manager

Overrides:

registerEvents in class StandardManager

Parameters:

managerService - the ManagerService with which to register events.

newStandardNotebookService

public static StandardNotebookService newStandardNotebookService()
                                                          throws WTException

Default factory for the class.

Supported API: false

Returns:

StandardNotebookService

Throws:

WTException

saveStructuredReference

public Notebook saveStructuredReference(SubjectOfNotebook subject,
                                        Notebook notebook)
                                 throws WTException

Supported API: false

Specified by:

saveStructuredReference in interface NotebookService

Parameters:

subject -

notebook -

Returns:

Notebook

Throws:

WTException

createNotebook

public Notebook createNotebook(NotebookTemplate template,
                               String name,
                               SubjectOfNotebook subject)
                        throws WTException

Deprecated.

deprecated in 7.0

Supported API: false

Specified by:

createNotebook in interface NotebookService

Parameters:

template -

name -

subject -

Returns:

Notebook

Throws:

WTException

addNotebook

public void addNotebook(NotebookIfc notebook,
                        SubjectOfNotebook subject,
                        boolean primary)
                 throws WTException

Supported API: false

Specified by:

addNotebook in interface NotebookService

Parameters:

notebook -

subject -

primary -

Throws:

WTException

getNotebooks

public Enumeration getNotebooks(WTObject subject)
                         throws WTException

Supported API: false

Specified by:

getNotebooks in interface NotebookService

Parameters:

subject -

Returns:

Enumeration

Throws:

WTException

createNotebook

public Notebook createNotebook(String templateName,
                               String name,
                               SubjectOfNotebook subject)
                        throws WTException

Deprecated.

Supported API: false

Specified by:

createNotebook in interface NotebookService

Parameters:

templateName -

name -

subject -

Returns:

Notebook

Throws:

WTException

getNotebooks

public Enumeration getNotebooks(WTObject subject,
                                boolean othersideonly)
                         throws WTException

Supported API: false

Specified by:

getNotebooks in interface NotebookService

Parameters:

subject -

othersideonly -

Returns:

Enumeration

Throws:

WTException

saveFolder

public NotebookFolder saveFolder(NotebookFolder folder)
                          throws WTException

Supported API: false

Specified by:

saveFolder in interface NotebookService

Parameters:

folder -

Returns:

NotebookFolder

Throws:

WTException

saveBookmark

public Bookmark saveBookmark(Bookmark bookmark)
                      throws WTException

Supported API: false

Specified by:

saveBookmark in interface NotebookService

Parameters:

bookmark -

Returns:

Bookmark

Throws:

WTException

deleteNotebook

public void deleteNotebook(Notebook notebook,
                           SubjectOfNotebook subject)
                    throws WTException

Supported API: false

Specified by:

deleteNotebook in interface NotebookService

Parameters:

notebook -

subject -

Throws:

WTException

deleteFolder

public void deleteFolder(NotebookFolder folder)
                  throws WTException

Supported API: false

Specified by:

deleteFolder in interface NotebookService

Parameters:

folder -

Throws:

WTException

saveWindchillBookmark

public void saveWindchillBookmark(String name,
                                  String s_url,
                                  CollaborationContainer parent)
                           throws WTException

Supported API: false

Specified by:

saveWindchillBookmark in interface NotebookService

Parameters:

name -

s_url -

parent -

Throws:

WTException

getChildren

public Enumeration getChildren(Notebook notebook)
                        throws WTException

Supported API: false

Specified by:

getChildren in interface NotebookService

Parameters:

notebook -

Returns:

Enumeration

Throws:

WTException

getDefaultTemplate

public NotebookTemplate getDefaultTemplate(WTObject obj,
                                           WTContainerRef containerRef)
                                    throws WTException

Supported API: false

Specified by:

getDefaultTemplate in interface NotebookService

Parameters:

obj -

containerRef -

Returns:

NotebookTemplate

Throws:

WTException

getFolders

public Vector getFolders(CollaborationContainer cc)
                  throws WTException

Supported API: false

Specified by:

getFolders in interface NotebookService

Parameters:

cc -

Returns:

Vector

Throws:

WTException

getDefaultObjectTemplate

public NotebookTemplate getDefaultObjectTemplate(boolean isUser,
                                                 WTContainerRef containerRef)
                                          throws WTException

Supported API: false

Specified by:

getDefaultObjectTemplate in interface NotebookService

Parameters:

isUser -

containerRef -

Returns:

NotebookTemplate

Throws:

WTException

getDefaultTemplate

public NotebookTemplate getDefaultTemplate(WTContainerRef containerRef)
                                    throws WTException

Supported API: false

Specified by:

getDefaultTemplate in interface NotebookService

Parameters:

containerRef -

Returns:

NotebookTemplate

Throws:

WTException

getApplicationData

public ApplicationData getApplicationData(String file,
                                          String tempFile,
                                          ContentHolder ctHolder)
                                   throws WTException

Supported API: false

Specified by:

getApplicationData in interface NotebookService

Parameters:

file -

tempFile -

ctHolder -

Returns:

ApplicationData

Throws:

WTException

createNotebookForUser

public Notebook createNotebookForUser(WTUser user)
                               throws WTException

Supported API: false

Specified by:

createNotebookForUser in interface NotebookService

Parameters:

user -

Returns:

Notebook

Throws:

WTException

getDefaultTemplate

public NotebookTemplate getDefaultTemplate(WTObject obj)
                                    throws WTException

Deprecated.

Supported API: false

Specified by:

getDefaultTemplate in interface NotebookService

Parameters:

obj -

Returns:

NotebookTemplate

Throws:

WTException

getDefaultTemplate

public NotebookTemplate getDefaultTemplate()
                                    throws WTException

Deprecated.

Supported API: false

Specified by:

getDefaultTemplate in interface NotebookService

Returns:

NotebookTemplate

Throws:

WTException

getDefaultObjectTemplate

public NotebookTemplate getDefaultObjectTemplate(boolean isUser)
                                          throws WTException

Deprecated.

Supported API: false

Specified by:

getDefaultObjectTemplate in interface NotebookService

Parameters:

isUser -

Returns:

NotebookTemplate

Throws:

WTException

createNotebook

public Notebook createNotebook(NotebookTemplate template,
                               String name,
                               SubjectOfNotebook subject,
                               WTContainerRef containerRef)
                        throws WTException

Supported API: false

Specified by:

createNotebook in interface NotebookService

Parameters:

template -

name -

subject -

containerRef -

Returns:

Notebook

Throws:

WTException

dispatchEvent

private void dispatchEvent(String eventType,
                           Object target)
                    throws WTException

Throws:

WTException

registerAsListener

private void registerAsListener()
                         throws ManagerException

Throws:

ManagerException

propogateDelete

public void propogateDelete(Enumeration childEnum)
                     throws WTException

Throws:

WTException

getOidString

public String getOidString(String url)

getNotebookTemplateStructure

private static String getNotebookTemplateStructure(boolean isUser)
                                            throws WTException

Throws:

WTException

getTemplate

private NotebookTemplate getTemplate(WTContainerRef containerRef)
                              throws WTException

Throws:

WTException

getObjectTemplate

public NotebookTemplate getObjectTemplate(WTContainerRef containerRef)
                                   throws WTException

Throws:

WTException

getFolders

private Vector getFolders(CollaborationContainer cc,
                          Vector retVec)
                   throws WTException

Throws:

WTException

getAllChildrenOfFolder

public Vector getAllChildrenOfFolder(NotebookFolder folder)
                              throws WTException

Throws:

WTException

getAllChildrenOfFolder

private Vector getAllChildrenOfFolder(NotebookFolder pnf,
                                      Vector retVec)
                               throws WTException

Throws:

WTException