ORG.oclc.webz
Class Verb

java.lang.Object
  |
  +--ORG.oclc.webz.Verb

Direct Known Subclasses:

CreateHTMLTemplate, MLOGOFF, MVerb, TemplateEditor, ZVerb

public class Verb

extends Object

implements JavaPage

The Verb class is parent class to all the WebZ Verbs implmented in the JaSSI. It defines variables shared by all the Verbs.

See Also:

JavaPage, RequestManager, UserStateObject, DataPairs, Log

Field Summary

protected UserStateObject	user UserStateObject object containing the user's state.
protected DataPairs	widgets DataPairs object containing a list of Widget objects.

Constructor Summary

Verb()
Constructs a Verb object containing no action.

Verb(RequestManager j)
Constructs a Verb object for the input RequestManager object.

Method Summary

void	runit(RequestManager rMngr) Executes the Verb based on the input parameters held in the input RequestManager object.
String	setUpPage(String page, int code, String msg) Sets up the next command or page for execution based on the input widget variable name(next or bad), code, and message and returns a String containing the command that can be set as the next in the RequestManager.
String	toString() Generates a String representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

widgets

protected DataPairs widgets

DataPairs object containing a list of Widget objects.

user

protected UserStateObject user

UserStateObject object containing the user's state.

Constructor Detail

Verb

public Verb()

Constructs a Verb object containing no action.

Verb

public Verb(RequestManager j)

Constructs a Verb object for the input RequestManager object.

Method Detail

runit

public void runit(RequestManager rMngr)

Executes the Verb based on the input parameters held in the input RequestManager object. Each method called from the runit() method can throw a SuccessPage or FailurePage exception. If this occurs, the catch logic for the exceptions invokes setup of either the next or bad page or command to execute upon return. Successful execution of all steps sets up the next page for execution upon return.

Specified by:

runit in interface JavaPage

toString

public String toString()

Generates a String representation of the object.

Returns:

String

Overrides:

toString in class Object

setUpPage

public String setUpPage(String page,
                        int code,
                        String msg)

Sets up the next command or page for execution based on the input widget variable name(next or bad), code, and message and returns a String containing the command that can be set as the next in the RequestManager.

Parameters:

page - the widget variable name (next or bad) to retrieve the command or page name from the current set of widgets.

code - the status of the activity that is set in the user entiry code

msg - the message generated by the activity that is set in the user entity msg

Returns:

String