okapi.tools
Class OkapiShowHelpM

java.lang.Object
  okapi.tools.OkapiShowHelpM

All Implemented Interfaces:

java.io.Serializable, OkapiToolModel

public class OkapiShowHelpM
extends java.lang.Object
implements OkapiToolModel

ToolModel for ShowHelp.

Version:

$Revision: 31044 $, $Date: 2008-09-02 17:08:01 -0400 (Tue, 02 Sep 2008) $

Author:

MIT Stellar team

See Also:

Serialized Form

Constructor Summary

OkapiShowHelpM()

Method Summary

protected static void	addHelpArcs(OkapiXMLDocument xml, OkapiNexus thisNexus, java.lang.String mode, OkapiUser user, java.util.List nexusHistory, boolean includeBodyEscapedXml)
OkapiToolModelReturn	returnObject(java.util.List pathVector, java.lang.String pathSegment, javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext context, java.util.List nexusHistory, java.lang.String requestedType) Return OkapiToolModelReturn object

Methods inherited from class java.lang.Object

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

Constructor Detail

OkapiShowHelpM

public OkapiShowHelpM()

Method Detail

returnObject

public OkapiToolModelReturn returnObject(java.util.List pathVector,
                                         java.lang.String pathSegment,
                                         javax.servlet.http.HttpServletRequest request,
                                         javax.servlet.ServletContext context,
                                         java.util.List nexusHistory,
                                         java.lang.String requestedType)
                                  throws OkapiPermissionDeniedException,
                                         OkapiAuthenticationRequiredException

Return OkapiToolModelReturn object

Specified by:

returnObject in interface OkapiToolModel

Parameters:

pathVector -

pathSegment -

request -

context -

nexusHistory -

requestedType -

Returns:

OkapiToolModelReturn

Throws:

OkapiAuthenticationRequiredException

OkapiPermissionDeniedException

addHelpArcs

protected static void addHelpArcs(OkapiXMLDocument xml,
                                  OkapiNexus thisNexus,
                                  java.lang.String mode,
                                  OkapiUser user,
                                  java.util.List nexusHistory,
                                  boolean includeBodyEscapedXml)
                           throws OkapiToolException

Throws:

OkapiToolException