com.groiss.dms
Interface XHTMLFormEventHandler

All Known Subinterfaces:

XHTMLFolderFormEventHandler

All Known Implementing Classes:

XHTMLFolderFormEventAdapter, XHTMLFormEventAdapter

public interface XHTMLFormEventHandler

This interface is used for writing callback classes enhancing the functionality of forms. The methods onInsert, onUpdate, and onDelete are called before the database operation is performed.
Additional information can be taken from the ThreadContext. If the database operation is done in the context of a HTTP interaction, the ThreadContext contains the HTTP-request with the following parameters:

• task: the oid of the activity instance (if it is a process form or sub-form)
• _src: the oid of the main form, if it is a subform
• _srcclass: the class name of the main form
• _id: the id of the form relation

Method Summary

void	beforeShow(DMSForm f, FormContext ctx, HttpServletRequest req) This method will be called before the page for the passed form is build.
String	getName(DMSForm f) Returns the name of this form.
void	onDelete(DMSForm f) This method is called before the form is deleted.
void	onInsert(DMSForm f) This method is called before the form is inserted in the store.
void	onShow(DMSForm f, FormContext ctx, XHTMLPage p, HttpServletRequest req) This method is called before the form is sent to the browser.
void	onUpdate(DMSForm f) This method is called before the form is updated to the store (the existing form in the store will be overwritten with the values of this form).

Method Detail

onInsert

void onInsert(DMSForm f)
              throws Exception

This method is called before the form is inserted in the store.

Parameters:

f - the form to insert

Throws:

Exception

onUpdate

void onUpdate(DMSForm f)
              throws Exception

This method is called before the form is updated to the store (the existing form in the store will be overwritten with the values of this form).

Parameters:

f - the form to update

Throws:

Exception

onDelete

void onDelete(DMSForm f)
              throws Exception

This method is called before the form is deleted.

Parameters:

f - the form to delete

Throws:

Exception

beforeShow

void beforeShow(DMSForm f,
                FormContext ctx,
                HttpServletRequest req)
                throws Exception

This method will be called before the page for the passed form is build. This allows particularily to set default values for form attributes which will be used when building the page.

Parameters:

f - the form to show

ctx - holds context information for the form

req - the http request requesting the form's page

Throws:

Exception

onShow

void onShow(DMSForm f,
            FormContext ctx,
            XHTMLPage p,
            HttpServletRequest req)
            throws Exception

This method is called before the form is sent to the browser.

Parameters:

f - the form to show

ctx - holds context information for the form

p - the xhtml page which will be sent to the browser

req - the http request requesting the form's page

Throws:

Exception

getName

String getName(DMSForm f)
               throws Exception

Returns the name of this form. If null is returned the default naming mechanism will be used.

Parameters:

f - the form which name is wanted

Returns:

the name of the form

Throws:

Exception