com.aspc.DBObj.Help

Class HelpItemScreenPlugin

java.lang.Object

com.aspc.DBObj.Help.HelpItemScreenPlugin

All Implemented Interfaces:

ProcessParametersPlugin

public class HelpItemScreenPlugin
extends java.lang.Object
implements ProcessParametersPlugin

HelpItemScreenPlugin The main purpose of this plugin is to remove duplicated HelpItem group maps This was necessary since when we are creating new HelpItems a default HelpItem group of user is assigned. When we refresh the screens readds the default along with the group already in the portal
THREAD MODE: MULTI-THREADED screen plugin

Since:

January 22, 2006

Author:

Mei Xiao

Constructor Summary

Constructors

Constructor and Description
HelpItemScreenPlugin(SDBScreen scrn) TODO: Not needed

Method Summary

Modifier and Type	Method and Description
void	addHiddenFields(SDBContext context, HTMLForm form) add hidden fields to the form
void	postProcessParameters(WebClient client, DBObject base) The data entry screen will call this method AFTER building the universe.
void	preProcessParameters(WebClient client, DBObject base) The data entry screen will call this method BEFORE building the universe from the parameters passed.
void	setProcessParametersAttribute(WebClient client, FormData fd) set the attribute
void	setProcessParametersOrder(WebClient client, java.util.ArrayList orderedList) set the order

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpItemScreenPlugin

public HelpItemScreenPlugin(SDBScreen scrn)

TODO: Not needed

Parameters:

scrn - The calling screen

Method Detail

preProcessParameters

public void preProcessParameters(WebClient client,
                                 DBObject base)
                          throws java.lang.Exception

The data entry screen will call this method BEFORE building the universe from the parameters passed. At this stage we may add and remove parameters to the client.

Specified by:

preProcessParameters in interface ProcessParametersPlugin

Parameters:

client - the web client

base - the base object

Throws:

java.lang.Exception - a serious problem

postProcessParameters

public void postProcessParameters(WebClient client,
                                  DBObject base)
                           throws java.lang.Exception

The data entry screen will call this method AFTER building the universe. You may create additional records etc. before the screen is layout

Specified by:

postProcessParameters in interface ProcessParametersPlugin

Parameters:

client - the web client

base - the base object

Throws:

java.lang.Exception - a serious problem

setProcessParametersAttribute

public void setProcessParametersAttribute(WebClient client,
                                          FormData fd)
                                   throws java.lang.Exception

set the attribute

Specified by:

setProcessParametersAttribute in interface ProcessParametersPlugin

Parameters:

client - the web client

fd - form data

Throws:

java.lang.Exception - a serious problem

setProcessParametersOrder

public void setProcessParametersOrder(WebClient client,
                                      java.util.ArrayList orderedList)
                               throws java.lang.Exception

set the order

Specified by:

setProcessParametersOrder in interface ProcessParametersPlugin

Parameters:

client - the web client

orderedList - the list

Throws:

java.lang.Exception - a serious problem

addHiddenFields

public void addHiddenFields(SDBContext context,
                            HTMLForm form)
                     throws java.lang.Exception

add hidden fields to the form

Specified by:

addHiddenFields in interface ProcessParametersPlugin

Parameters:

context - the context

form - the form

Throws:

java.lang.Exception - a serious problem