com.aspc.Layers.aspc_app.Invoice.plugins

Class InvoicePaymentScreenPlugin

java.lang.Object

com.aspc.Layers.aspc_app.Invoice.plugins.InvoicePaymentScreenPlugin

All Implemented Interfaces:

ButtonBarPlugin, ProcessParametersPlugin, ScreenWorkflowPlugin, ShowComponentPlugin

public class InvoicePaymentScreenPlugin
extends java.lang.Object
implements ProcessParametersPlugin, ShowComponentPlugin, ScreenWorkflowPlugin, ButtonBarPlugin

PartOrderScreen
THREAD MODE: MULTI-THREADED screen plugin

Since:

4 September 2003

Author:

Jason McGrath

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	nextScreenAction

Fields inherited from interface com.supertracker.ScreenObj.Plugin.ScreenWorkflowPlugin

SCREEN_ACTION_CLOSE, SCREEN_ACTION_DELETE, SCREEN_ACTION_EMAIL, SCREEN_ACTION_PRINT, SCREEN_ACTION_SAVE, SCREEN_ACTION_SAVE_AND_EXIT

Constructor Summary

Constructors

Constructor and Description
InvoicePaymentScreenPlugin(SDBScreen scrn)

Method Summary

Modifier and Type	Method and Description
void	addButtons(SDBScreenContext context, HTMLPage page, java.lang.String next, java.util.ArrayList list) Add some more buttons.
void	addHiddenFields(SDBContext context, HTMLForm form) add hidden fields to the form
java.lang.String	determineScreenAction(SDBScreenContext context, java.lang.String nextAction) The action that is to be performed by the screen If no processing is required then the nextAction paramater should be returned without change
java.lang.String	getNextWindowTarget(SDBScreenContext context, java.lang.String target) The target window that should be used for nextWindowUrl If no processing is required then the target parameter should be returned without change
java.lang.String	getNextWindowUrl(SDBScreenContext context, java.lang.String url) The window that should be opened after screen processing has completed If no processing is required then the url parameter should be returned without change
void	postProcessParameters(WebClient client, DBObject base) The main purpose of this procedure is to ensure that the screen shows at least one partOrderBreakdown entry for product item linked to current invoice.
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
boolean	showComponent(SDBContext context, SDBComponent component) Should we show this component ?

Methods inherited from class java.lang.Object

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

Field Detail

nextScreenAction

public java.lang.String nextScreenAction

Constructor Detail

InvoicePaymentScreenPlugin

public InvoicePaymentScreenPlugin(SDBScreen scrn)

Parameters:

scrn -

Method Detail

preProcessParameters

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

Description copied from interface: ProcessParametersPlugin

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 client to use

base - the base object

Throws:

java.lang.Exception - a serious problem

addButtons

public void addButtons(SDBScreenContext context,
                       HTMLPage page,
                       java.lang.String next,
                       java.util.ArrayList list)

Description copied from interface: ButtonBarPlugin

Add some more buttons. You can add or remove buttons from the list.

Specified by:

addButtons in interface ButtonBarPlugin

Parameters:

context - the context

postProcessParameters

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

The main purpose of this procedure is to ensure that the screen shows at least one partOrderBreakdown entry for product item linked to current invoice.

Specified by:

postProcessParameters in interface ProcessParametersPlugin

Parameters:

client - the client to use

base - the base object

Throws:

java.lang.Exception - a serious problem

setProcessParametersAttribute

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

Description copied from interface: ProcessParametersPlugin

set the attribute

Specified by:

setProcessParametersAttribute in interface ProcessParametersPlugin

Parameters:

client - the client to use

fd -

Throws:

java.lang.Exception - a serious problem

setProcessParametersOrder

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

Description copied from interface: ProcessParametersPlugin

set the order

Specified by:

setProcessParametersOrder in interface ProcessParametersPlugin

Parameters:

client - the client to use

orderedList -

Throws:

java.lang.Exception - a serious problem

addHiddenFields

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

Description copied from interface: ProcessParametersPlugin

add hidden fields to the form

Specified by:

addHiddenFields in interface ProcessParametersPlugin

Parameters:

context - the context

form -

Throws:

java.lang.Exception - a serious problem

showComponent

public boolean showComponent(SDBContext context,
                             SDBComponent component)

Description copied from interface: ShowComponentPlugin

Should we show this component ?

Specified by:

showComponent in interface ShowComponentPlugin

Parameters:

context - the context

component -

Returns:

the value

determineScreenAction

public java.lang.String determineScreenAction(SDBScreenContext context,
                                              java.lang.String nextAction)
                                       throws java.lang.Exception

Description copied from interface: ScreenWorkflowPlugin

The action that is to be performed by the screen If no processing is required then the nextAction paramater should be returned without change

Specified by:

determineScreenAction in interface ScreenWorkflowPlugin

Parameters:

context - the context

nextAction -

Returns:

the value

Throws:

java.lang.Exception - Exception A serious problem

getNextWindowUrl

public java.lang.String getNextWindowUrl(SDBScreenContext context,
                                         java.lang.String url)

Description copied from interface: ScreenWorkflowPlugin

The window that should be opened after screen processing has completed If no processing is required then the url parameter should be returned without change

Specified by:

getNextWindowUrl in interface ScreenWorkflowPlugin

Parameters:

context - the context

url -

Returns:

the value

getNextWindowTarget

public java.lang.String getNextWindowTarget(SDBScreenContext context,
                                            java.lang.String target)

Description copied from interface: ScreenWorkflowPlugin

The target window that should be used for nextWindowUrl If no processing is required then the target parameter should be returned without change

Specified by:

getNextWindowTarget in interface ScreenWorkflowPlugin

Parameters:

context - the context

target -

Returns:

the value