wt.clients.doc
Class WTDocumentMasterTaskDelegate

java.lang.Object
  wt.clients.util.TaskDelegate
      wt.clients.doc.WTDocumentMasterTaskDelegate

public class WTDocumentMasterTaskDelegate

extends TaskDelegate

Class WTDocumentMasterTaskDelegate provides support for launching the tasks to create, update and view WTDocumentMasters. This class should not be directly instantiated or manipulated. Instead, obtain a wt.clients.util.TaskDelegate from the wt.clients.util.TaskDelegateFactory for a specific object or class, and invoke methods on that obtained TaskDelegate.

Supported API: false

Extendable: false

See Also:

TaskDelegate, TaskDelegateFactory, WTDocumentMaster

Field Summary

Fields inherited from class wt.clients.util.TaskDelegate

ACTION_KEY, OBJ_PROPS_ACTION, object, objReference, OID_KEY, parentApplet, parentFolder, parentFrame, URL_TEMPLATE_ACTION, URLPROCESSOR_CLASS

Constructor Summary

WTDocumentMasterTaskDelegate()
Create the task delegate.

Method Summary

Applet	getApplet() Return the parent applet.
Frame	getFrame() Return the parent frame.
Object	getObject() Return the object the manipulate.
protected Versioned	getVersionForMaster(Mastered master)
void	launchCreateTask() This method is only a nop implementation to support the interface.
void	launchDeleteTask() This method is only a nop implementation to support the interface.
void	launchUpdateTask() This method is only a nop implementation to support the interface.
void	launchViewTask() Launch the task to view a given WTDocumentMaster.
static void	main(String[] args) A main method that demonstrates how to use this class and allows testing

Methods inherited from class wt.clients.util.TaskDelegate

confirmAction, deleteObject, displayPropertiesPage, getParentApplet, getParentFolder, getParentFrame, launchSaveAsTask, launchViewDistributionListTask, setObject, setObjectReference, setParentApplet, setParentFolder, setParentFrame

Methods inherited from class java.lang.Object

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

Constructor Detail

WTDocumentMasterTaskDelegate

public WTDocumentMasterTaskDelegate()

Create the task delegate.

Method Detail

getObject

public Object getObject()

Return the object the manipulate.

Overrides:

getObject in class TaskDelegate

Returns:

the object to manipulate

See Also:

TaskDelegate.getObject(), TaskDelegate.launchViewTask(), TaskDelegate.launchUpdateTask(), TaskDelegate.launchDeleteTask(), WTReference

getFrame

public Frame getFrame()

Return the parent frame.

Returns:

the parent frame.

getApplet

public Applet getApplet()

Return the parent applet.

Returns:

the parent applet

launchCreateTask

public void launchCreateTask()
                      throws TaskDelegateException

This method is only a nop implementation to support the interface. Creating WTDocumentMasters directly is not allowed from the Java Client.

Overrides:

launchCreateTask in class TaskDelegate

Throws:

TaskDelegateException - if an error occurs attempting to set the folder in which to create the document

See Also:

WTDocumentMaster

launchViewTask

public void launchViewTask()
                    throws TaskDelegateException,
                           ObjectNoLongerExistsException,
                           NotAuthorizedException,
                           WTException

Launch the task to view a given WTDocumentMaster. This method will display the HTML properties page for the document master.

Overrides:

launchViewTask in class TaskDelegate

Throws:

TaskDelegateException - if no object has been given to update or the given object is not a WTDocument

NotAuthorizedException - if the current user does not have permission to modify nor view the given WTDocument

ObjectNoLongerExistsException - the given WTDocument no longer exists in the database

WTException - if an error occurs preparing the given WTDcoument for modification

See Also:

WTDocumentMaster

launchUpdateTask

public void launchUpdateTask()
                      throws TaskDelegateException,
                             ObjectNoLongerExistsException,
                             ModificationNotAllowedException,
                             NotAuthorizedException,
                             WTException

This method is only a nop implementation to support the interface. Updating WTDocumentMasters directly is not allowed from the Java Client.

Overrides:

launchUpdateTask in class TaskDelegate

Throws:

TaskDelegateException - if no object has been given to update or the given object is not a WTDocument

ModificationNotAllowedException - if the current user has permission to view but not to modify the given WTDocument

NotAuthorizedException - if the current user does not have permission to modify nor view the given WTDocument

ObjectNoLongerExistsException - the given WTDocument no longer exists in the database

WTException - if an error occurs preparing the given WTDocument for modification

See Also:

WTDocumentMaster

launchDeleteTask

public void launchDeleteTask()
                      throws TaskDelegateException

This method is only a nop implementation to support the interface. Deleting WTDocumentMasters directly is not allowed from the Java Client.

Overrides:

launchDeleteTask in class TaskDelegate

Throws:

TaskDelegateException - if no object has been given to delete or the given object is not a WTDocument or if error deleting the WTDocument.

See Also:

WTDocumentMaster

getVersionForMaster

protected Versioned getVersionForMaster(Mastered master)

main

public static void main(String[] args)

A main method that demonstrates how to use this class and allows testing