com.ibm.workflow.servlet.clientx.wext
Class RestartAsDraftHandler

java.lang.Object
  |
  +--com.ibm.workflow.servlet.client.GenericCommandHandler
        |
        +--com.ibm.workflow.servlet.clientx.wext.WExtCommandHandler
              |
              +--com.ibm.workflow.servlet.clientx.wext.RestartAsDraftHandler

public class RestartAsDraftHandler
extends WExtCommandHandler

This class enables the end user to save a current executing activity as a draft. Once he/she did Draft Save, it can be restart and continue to input again at anytime in the future.


Constructor Summary
RestartAsDraftHandler()
           
 
Method Summary
 com.ibm.workflow.servlet.client.ResponsePage completeWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This custom command check-in work item.
 java.lang.String getHandlerInfo()
          Returns information about the handler.
 java.lang.String getTriggerTagFor(int list, com.ibm.workflow.servlet.client.RequestContext context)
          Returns a String that contains HTML code to trigger the restart as draft command.
 void init(com.ibm.workflow.servlet.client.Config cfg)
          Initializes the handler.
 com.ibm.workflow.servlet.client.ResponsePage restartAsDraftWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This custom command first retrieves the output container data of the work item whose OID matches the 'id' parameter in the HTTP-request.
 com.ibm.workflow.servlet.client.ResponsePage retrieveDraftWorkItem(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This custom command does not cancelWorkItem but check-in with old data.
 
Methods inherited from class com.ibm.workflow.servlet.client.GenericCommandHandler
destroy, execute, getConfig, getContext, getCredentials, getSessionContext, onLogoff, onLogon
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RestartAsDraftHandler

public RestartAsDraftHandler()
Method Detail

getHandlerInfo

public java.lang.String getHandlerInfo()
Returns information about the handler.
Overrides:
getHandlerInfo in class com.ibm.workflow.servlet.client.GenericCommandHandler
Returns:
a String containing handler information

init

public void init(com.ibm.workflow.servlet.client.Config cfg)
Initializes the handler.
Overrides:
init in class WExtCommandHandler
Parameters:
config - the servlet's configuration and initialization parameters

getTriggerTagFor

public java.lang.String getTriggerTagFor(int list,
                                         com.ibm.workflow.servlet.client.RequestContext context)
Returns a String that contains HTML code to trigger the restart as draft command.
Overrides:
getTriggerTagFor in class com.ibm.workflow.servlet.client.GenericCommandHandler
Parameters:
list - denotes the list for which the trigger tag is queried.
context - the RequestContext which was passed to the Viewer calling this method.
Returns:
a string containing HTML tags for the icons to be displayed on list.

restartAsDraftWorkItem

public com.ibm.workflow.servlet.client.ResponsePage restartAsDraftWorkItem(javax.servlet.http.HttpServletRequest request,
                                                                           javax.servlet.http.HttpServletResponse response)
                                                                    throws com.ibm.workflow.servlet.client.ClientException
This custom command first retrieves the output container data of the work item whose OID matches the 'id' parameter in the HTTP-request. Then the command creates a ReuseData object as a request bean to keep old data for reuse. The resulting HTML data is created by checkOutWorkItem rendering.
Parameters:
request - the request the client has made of the servlet
response - the response the servlet sends to the client
Returns:
the result page to be sent to the client

completeWorkItem

public com.ibm.workflow.servlet.client.ResponsePage completeWorkItem(javax.servlet.http.HttpServletRequest request,
                                                                     javax.servlet.http.HttpServletResponse response)
                                                              throws com.ibm.workflow.servlet.client.ClientException
This custom command check-in work item.
Parameters:
request - the request the client has made of the servlet
response - the response the servlet sends to the client
Returns:
the result page to be sent to the client

retrieveDraftWorkItem

public com.ibm.workflow.servlet.client.ResponsePage retrieveDraftWorkItem(javax.servlet.http.HttpServletRequest request,
                                                                          javax.servlet.http.HttpServletResponse response)
                                                                   throws com.ibm.workflow.servlet.client.ClientException
This custom command does not cancelWorkItem but check-in with old data.
Parameters:
request - the request the client has made of the servlet
response - the response the servlet sends to the client
Returns:
the result page to be sent to the client