de.must.markup

Interface Invokable

All Known Implementing Classes:

Back, ColumnDataList, DataList, DataPropertyAdministration, DataPropertyPresentation, DataTableAdministration, Dialog, Enquiry, LanguageChooserStd, LayoutChooserStd, List, LoginDialog, MustMenuBar, PasswordChangeDialogStd, PropertyAdministration, PropertyPresentation, SimpleDataList

public interface Invokable

Invokables are components to be invoked by SessionStd and put in stack to control state maintaining and back functionality. Most of the invokables are dialogs to be nested in order to support complex administration. They show their face to the user via method #getTagSequence.

See Also:

SessionStd, Dialog

Method Summary

Modifier and Type	Method and Description
void	afterOutput() Called by SessionStd after the servlet response is written.
void	beforeOutput() Called by SessionStd before the servlet response is written.
void	destroy() Destroy this object in order to free resources and weak references more early than garbage collector.
void	fetchValuesFromRequest(GeneralizedRequest request) Causes the invokable to delegate this function to all embedded markupables to fetch their current value as edited by the user from the request.
java.lang.Class<? extends Invokable>	getInvokableInAdvance() Returns a Invokable class which is to be invoked before this Invokable can be shown.
int	getStackMovement() Returns the wished stack movement.
Submission	getSubmission() Informs the next invokable in stack about the submission details.
void	init() Initializes the invokable in order to reuse the component without garbage from previous usage.
boolean	isCancelable() Indicates whether the invokable accepts to be canceled.
boolean	isSuitableDialog(GeneralizedRequest request) Indicates whether the request fits to this dialog.
void	process(GeneralizedRequest request) Allows the invokable to react to the request.
void	setSubmitter(Invokable submitter) Informs this invokable, from which previous invokable it is submitted.
boolean	wantToBeFinalized() Returns true if the invokable wants to be finalized after request is worked off.

Method Detail

init

void init()

Initializes the invokable in order to reuse the component without garbage from previous usage.

getInvokableInAdvance

java.lang.Class<? extends Invokable> getInvokableInAdvance()

Returns a Invokable class which is to be invoked before this Invokable can be shown. Sample: if a function needs a login, this login is to be done in advance.

Returns:

a Invokable class which is to be invoked before this Invokable can be shown

beforeOutput

void beforeOutput()

Called by SessionStd before the servlet response is written.

See Also:

SessionStd

afterOutput

void afterOutput()

Called by SessionStd after the servlet response is written.

See Also:

SessionStd

isCancelable

boolean isCancelable()

Indicates whether the invokable accepts to be canceled. E.g. if properties are edited and jumping to another function is requested by using a toolbar option, this may be stopped here.

Returns:

true if the invokable accepts to be canceled

isSuitableDialog

boolean isSuitableDialog(GeneralizedRequest request)

Indicates whether the request fits to this dialog. Useful to stop the user to use any back functions of the browser.

Parameters:

request - the request to check

Returns:

true if the request fits to this dialog

fetchValuesFromRequest

void fetchValuesFromRequest(GeneralizedRequest request)

Causes the invokable to delegate this function to all embedded markupables to fetch their current value as edited by the user from the request.

Parameters:

request - the request from where the values are to be fetched

See Also:

Markupable#fetchYourValueFromRequest

process

void process(GeneralizedRequest request)

Allows the invokable to react to the request. Sample: saving data when OK button was pressed.

Parameters:

request - the request to react to

setSubmitter

void setSubmitter(Invokable submitter)

Informs this invokable, from which previous invokable it is submitted. Technique to establish a bilateral communication between invokables.

Parameters:

submitter - the invokable that submitted this invokable

getSubmission

Submission getSubmission()

Informs the next invokable in stack about the submission details. E.g. a PropertyAdminstration may call this method to receive the primary key of the entry to be edited.

Returns:

the submission details

getStackMovement

int getStackMovement()

Returns the wished stack movement. E.g this if this invokable's work is done it return -1 to return to the previous invokable in the stack.

wantToBeFinalized

boolean wantToBeFinalized()

Returns true if the invokable wants to be finalized after request is worked off. Called by SessionStd

Returns:

true if the invokable wants to be finalized

destroy

void destroy()

Destroy this object in order to free resources and weak references more early than garbage collector.