com.aspc.workflow

Class DisplayAlertsPlugin

java.lang.Object

com.aspc.workflow.DisplayAlertsPlugin

All Implemented Interfaces:

MakeHTMLComponentPlugin, ProcessParametersPlugin

public class DisplayAlertsPlugin
extends java.lang.Object
implements MakeHTMLComponentPlugin, ProcessParametersPlugin

Sets up components which show information about alerts
THREAD MODE: MULTI-THREADED screen plugin

Since:

April 3, 2003

Author:

Jason McGrath

Constructor Summary

Constructors

Constructor and Description
DisplayAlertsPlugin(SDBScreen scrn) Default constructor

Method Summary

Modifier and Type	Method and Description
void	addHiddenFields(SDBContext context, HTMLForm form) Adds additional hidden fields to the form
HTMLComponent	makeHTMLComponent(SDBContext context, SDBComponent screenComponent, HTMLComponent htmlComponent) Creates a component for displaying the text of the alert The text is colored based on the settings of the alert A link is created to point to either the object that the alert refers to or the alert if non exists.
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 processing the list of parameters
void	setProcessParametersAttribute(WebClient client, FormData fd) Allows modification of instructions for each parameter, i.e is auto entered
void	setProcessParametersOrder(WebClient client, java.util.ArrayList orderedList) Allows modification on the order that the parameters will be applied to the database

Methods inherited from class java.lang.Object

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

Constructor Detail

DisplayAlertsPlugin

public DisplayAlertsPlugin(SDBScreen scrn)

Default constructor

Parameters:

scrn - - the screen that the plugin is associated with

Method Detail

preProcessParameters

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

The data entry screen will call this method BEFORE processing the list of parameters

Specified by:

preProcessParameters in interface ProcessParametersPlugin

Parameters:

client - - webclient

base - - Global object

Throws:

java.lang.Exception - - as serious error

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. At this point we clear out any unwanted alerts.

Specified by:

postProcessParameters in interface ProcessParametersPlugin

Parameters:

client - - webclient

base - - Global object

Throws:

java.lang.Exception - - a serious error

makeHTMLComponent

public HTMLComponent makeHTMLComponent(SDBContext context,
                                       SDBComponent screenComponent,
                                       HTMLComponent htmlComponent)
                                throws java.lang.Exception

Creates a component for displaying the text of the alert The text is colored based on the settings of the alert A link is created to point to either the object that the alert refers to or the alert if non exists.

Specified by:

makeHTMLComponent in interface MakeHTMLComponentPlugin

Parameters:

context - - current screen context

screenComponent - - component that we are generating htmlcomponent for

htmlComponent - - htmlComponent generated by system

Returns:

the HTML component to be palced on a screen

Throws:

java.lang.Exception - - a serious error

setProcessParametersAttribute

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

Allows modification of instructions for each parameter, i.e is auto entered

Specified by:

setProcessParametersAttribute in interface ProcessParametersPlugin

Parameters:

client - - current client

fd - - parameter details

Throws:

java.lang.Exception - - as serious error

setProcessParametersOrder

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

Allows modification on the order that the parameters will be applied to the database

Specified by:

setProcessParametersOrder in interface ProcessParametersPlugin

Parameters:

client - - current client

orderedList - - list of parameters

Throws:

java.lang.Exception - - a serious error

addHiddenFields

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

Adds additional hidden fields to the form

Specified by:

addHiddenFields in interface ProcessParametersPlugin

Parameters:

context - - current screen context

form - - current form to add hidden fields to

Throws:

java.lang.Exception - - a serious error