ORG.oclc.mantis.verbs
Class MVerb

java.lang.Object
  |
  +--ORG.oclc.webz.Verb
        |
        +--ORG.oclc.mantis.verbs.MVerb

Direct Known Subclasses:

ESLock, LoadWorkForm, MCANCEL, MCLONE, MDELETE, MDISPLAY, MEDIT, MEXPORT, MSAVE, MTLOAD, MUNSAVE, MUPDATE, MVIEW

public class MVerb

extends Verb

The MVerb class is one of the baseline Z39.50 classes for implementing WebZ in Java. All WebZ Verbs that perform Z39.50 activities extend this class. It performs shared activities for those classes and defines shared variables as well.

See Also:

JavaPage, UserStateObject, Log, AccessClient, AccessUserData

Field Summary

protected IClient	accessClient
protected String	action
protected int	actionNode
protected String	app_page
protected String	autho
protected boolean	dirtyTemplate
static String	DISPLAYCMD
static String	EDITCMD
protected String	editsessionid
protected int	editTimeout
protected Hashtable	esi_user
protected String	lockServerHost
protected String	lockServerPort
static String	NOLOCKBACKUP
static String	NOLOCKUPDATE
protected RequestManager	rMngr
protected StyleTable	style
static String	SUCCESS
protected String	templateName
static String	VIEWCMD

Fields inherited from class ORG.oclc.webz.Verb

user, widgets

Constructor Summary

MVerb()
Constructs a MVerb object.

MVerb(RequestManager r)
Constructs a MVerb object for the input RequestManager object.

Method Summary

String	authWarnMsg(String operation, String autho)
protected EditSessionInfo	doInit() Deprecated. This method is no longer used. Its functionality has been replaced by initMUser()
protected boolean	getLock(EditSessionInfo esi, int editTimeout, String operation) Obtain a lock for a editSession.
protected DataPairs	getModule() Locate the widget that is the module to invoked.
protected DataPairs	getModule(DataPairs w) Locate the widget that is the module to invoked.
protected DataPairs	getModule(RequestManager r) Locate the widget that is the module to invoked.
protected EditSessionInfo	initMUser() Method used creates or loactes the correct EditSessionInfo object.
protected String	makeBody(int level, EditSessionInfo esi)
String	noLockWarnMsg(String operation, String autho)
protected void	releaseLock(EditSessionInfo esi) Remove a lock for a editSession.
void	runit(RequestManager r)
void	setButton(String button)
void	setButton(String button, Hashtable edit_user)
protected EditSessionInfo	setupEditSession(EditSessionInfo esi)
void	stdClose(EditSessionInfo esi)
protected void	stdSetup(RequestManager r)
String	toString() Generates a String representation of the object.
void	unSetButton(String button)

Methods inherited from class ORG.oclc.webz.Verb

setUpPage

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final String SUCCESS

NOLOCKBACKUP

public static final String NOLOCKBACKUP

NOLOCKUPDATE

public static final String NOLOCKUPDATE

actionNode

protected int actionNode

action

protected String action

app_page

protected String app_page

autho

protected String autho

dirtyTemplate

protected boolean dirtyTemplate

editTimeout

protected int editTimeout

editsessionid

protected String editsessionid

esi_user

protected Hashtable esi_user

lockServerPort

protected String lockServerPort

lockServerHost

protected String lockServerHost

rMngr

protected RequestManager rMngr

style

protected StyleTable style

templateName

protected String templateName

accessClient

protected IClient accessClient

EDITCMD

public static final String EDITCMD

VIEWCMD

public static final String VIEWCMD

DISPLAYCMD

public static final String DISPLAYCMD

Constructor Detail

MVerb

public MVerb()

Constructs a MVerb object.

MVerb

public MVerb(RequestManager r)

Constructs a MVerb object for the input RequestManager object.

Method Detail

doInit

protected EditSessionInfo doInit()

Deprecated. This method is no longer used. Its functionality has been replaced by initMUser()

Same as initMUser().

Returns:

EditSessionInfo -- the collection of data used by the Mantis toolkit to manipulate a record.

getLock

protected boolean getLock(EditSessionInfo esi,
                          int editTimeout,
                          String operation)

Obtain a lock for a editSession.

Parameters:

esi - The editSessionInfo object the lock is for.

editTimeout - The amount of time the lock is to be held. (NOTE: the value is seconds).

Returns:

true - lock was obtained false - otherwise.

getModule

protected DataPairs getModule()

Locate the widget that is the module to invoked. If the widget has a Qualifier (e.g., rem43.x) it seperates the "module" from the Qualifying string. For example: rem43.x yields module=rem:modulenode=43. Finally, no qualified module widget is located it locates the widget named "module".

Returns:

values - The DataPairs object that contain the module and moduleNode located. Null if no "module" widget (Qualified or Unqualified) was located.

getModule

protected DataPairs getModule(RequestManager r)

Locate the widget that is the module to invoked. If the widget has a Qualifier (e.g., rem43.x) it seperates the "module" from the Qualifying string. For example: rem43.x yields module=rem:modulenode=43. Finally, no qualified module widget is located it locates the widget named "module".

Parameters:

rMngr - - the RequestManager to extract the widgets from.

Returns:

values - The DataPairs object that contain the module and moduleNode located. Null if no "module" widget (Qualified or Unqualified) was located.

getModule

protected DataPairs getModule(DataPairs w)

Locate the widget that is the module to invoked. If the widget has a Qualifier (e.g., rem43.x) it seperates the "module" from the Qualifying string. For example: rem43.x yields module=rem:modulenode=43. Finally, no qualified module widget is located it locates the widget named "module".

Parameters:

w - - the widgets extract the module from.

Returns:

values - The DataPairs object that contain the module and moduleNode located. Null if no "module" widget (Qualified or Unqualified) was located.

initMUser

protected EditSessionInfo initMUser()

Method used creates or loactes the correct EditSessionInfo object. Uses the "editsessionid" widget to locate the correct session. Locates the correct template from the dbname. From the template locates and executes the fromNative() hook. Loads the dir as XML document.

Returns:

EditSessionInfo -- the collection of data used by the Mantis toolkit to manipulate a record.

makeBody

protected String makeBody(int level,
                          EditSessionInfo esi)

releaseLock

protected void releaseLock(EditSessionInfo esi)

Remove a lock for a editSession.

Parameters:

esi - the editSessionInfo object.

runit

public void runit(RequestManager r)

Overrides:

runit in class Verb

setButton

public void setButton(String button)

setButton

public void setButton(String button,
                      Hashtable edit_user)

setupEditSession

protected EditSessionInfo setupEditSession(EditSessionInfo esi)

stdSetup

protected void stdSetup(RequestManager r)

stdClose

public void stdClose(EditSessionInfo esi)

toString

public String toString()

Generates a String representation of the object.

Returns:

String

Overrides:

toString in class Verb

unSetButton

public void unSetButton(String button)

authWarnMsg

public String authWarnMsg(String operation,
                          String autho)

noLockWarnMsg

public String noLockWarnMsg(String operation,
                            String autho)