com.ibm.workflow.portlet.sample
Class HTMLDocHandler

java.lang.Object
  |
  +--com.ibm.workflow.portlet.client.GenericCommandHandler
        |
        +--com.ibm.workflow.portlet.sample.HTMLDocHandler
All Implemented Interfaces:
CommandHandler

public class HTMLDocHandler
extends GenericCommandHandler

This class provides a link from process template lists to the HTML documentation exported from Buildtime. It does not define a new command but simply creates a hyperlinked icon for processes where online documentation is available. It is assumed that the HTML documentation is located in the ProcessDocs subdirectory of the Web Client's document root directory.

For details on how to run this sample, see the Samples section.


Constructor Summary
HTMLDocHandler()
           
 
Method Summary
 java.lang.String getHandlerInfo()
          Returns information about the handler, such as author, version, and copyright.
 java.lang.String getTriggerTagFor(int list, RequestContext context)
          Returns an HTML tag to be included in process template lists.
 
Methods inherited from class com.ibm.workflow.portlet.client.GenericCommandHandler
destroy, execute, getConfig, getContext, getCredentials, getSessionContext, init, onLogoff, onLogon
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HTMLDocHandler

public HTMLDocHandler()
Method Detail

getHandlerInfo

public java.lang.String getHandlerInfo()
Returns information about the handler, such as author, version, and copyright.
Overrides:
getHandlerInfo in class GenericCommandHandler
Returns:
a String containing handler information

getTriggerTagFor

public java.lang.String getTriggerTagFor(int list,
                                         RequestContext context)
Returns an HTML tag to be included in process template lists. This tag points to the online process documentation where available.
Overrides:
getTriggerTagFor in class GenericCommandHandler
Returns:
a String containing a href or an empty String if no online documentation is available


© Copyright IBM Corporation 2002, 2008. All Rights Reserved.