wt.clients.effectivity
Class ConfigurationItemTaskDelegate

java.lang.Object
  extended bywt.clients.util.TaskDelegate
      extended bywt.clients.effectivity.ConfigurationItemTaskDelegate

public class ConfigurationItemTaskDelegate
extends TaskDelegate

Class ConfigurationItemTaskDelegate provides support for launching the tasks to create, update and view ConfigurationItems.

Supported API: true.

Extendable: true.

See Also:
TaskDelegate

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
ConfigurationItemTaskDelegate()
          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.
 void launchCreateTask()
          Method launchCreateTask launches the ConfigItemFrame to create a new ConfigurationItem.
 void launchUpdateTask()
          Method launchUpdateTask launches the ConfigItemFrame to update a given ConfigurationItem.
 void launchViewTask()
          Method launchViewTask launches the ConfigItemFrame to view a given ConfigurationItem.
 
Methods inherited from class wt.clients.util.TaskDelegate
confirmAction, deleteObject, displayPropertiesPage, getParentApplet, getParentFolder, getParentFrame, launchDeleteTask, 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

ConfigurationItemTaskDelegate

public ConfigurationItemTaskDelegate()
Create the task delegate.

Supported API: true.

Method Detail

getObject

public Object getObject()
Return the object the manipulate.

Supported API: true.

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.

Supported API: true.

Returns:
the parent frame.

getApplet

public Applet getApplet()
Return the parent applet.

Supported API: true.

Returns:
the parent applet

launchCreateTask

public void launchCreateTask()
                      throws TaskDelegateException
Method launchCreateTask launches the ConfigItemFrame to create a new ConfigurationItem.

Supported API: true.

Overrides:
launchCreateTask in class TaskDelegate
Throws:
TaskDelegateException - if an error occurs attempting to set the folder in which to create the document
See Also:
ConfigItemFrame, ConfigurationItem

launchViewTask

public void launchViewTask()
                    throws TaskDelegateException,
                           ObjectNoLongerExistsException,
                           WTException,
                           NotAuthorizedException
Method launchViewTask launches the ConfigItemFrame to view a given ConfigurationItem.

Supported API: true.

Overrides:
launchViewTask in class TaskDelegate
Throws:
TaskDelegateException - if no object has been given to view or the given object is not a ConfigurationItem
ObjectNoLongerExistsException - if the object no longer exists in the database
NotAuthorizedException - if the current user does not have permission to view the object
WTException - if an error occurs preparing the object for viewing
See Also:
ConfigItemFrame, ConfigurationItem

launchUpdateTask

public void launchUpdateTask()
                      throws TaskDelegateException,
                             ObjectNoLongerExistsException,
                             ModificationNotAllowedException,
                             NotAuthorizedException,
                             WTException
Method launchUpdateTask launches the ConfigItemFrame to update a given ConfigurationItem. Before launching the frame in which to update the ConfigurationItme, this method will verify that the given ConfigurationItem is available for modification.

Supported API: true.

Overrides:
launchUpdateTask in class TaskDelegate
Throws:
TaskDelegateException - if no object has been given to update or the given object is not a ConfigurationItem
ModificationNotAllowedException - if the current user has permission to view but not to modify the given ConfigurationItem
NotAuthorizedException - if the current user does not have permission to modify nor view the given ConfigurationItem
ObjectNoLongerExistsException - the given ConfigurationItem no longer exists in the database
WTException - if an error occurs preparing the given ConfigurationItem for modification
See Also:
ConfigItemFrame, ConfigurationItem