de.must.markup

Class Enquiry

java.lang.Object

de.must.markup.Dialog

de.must.markup.Enquiry

All Implemented Interfaces:

Invokable

public abstract class Enquiry
extends Dialog

Dialog for entering inquiry specifications.

Field Summary

Fields

Modifier and Type	Field and Description
protected AttributeList	currentAttributeList
protected DataObject	dataObjectForGlobalSearch
protected MustTextField	globalSearchTextField
protected boolean	wantToBeFinalized

Fields inherited from class de.must.markup.Dialog

additionalButtons, backButton, cancelButton, NAME_FOR_BACK_ACTION, NAME_FOR_CANCEL_ACTION, NAME_FOR_CLOSE_ACTION, NAME_FOR_DIALOG_NBR, NAME_FOR_HELP_ACTION, NAME_FOR_LIST_ACTION, NAME_FOR_NEW_ENTRY_ACTION, NAME_FOR_OK_ACTION, okButton, processComplete, sessionData, stackMovement

Constructor Summary

Constructors

Constructor and Description
Enquiry(SessionData sessionData) Constructs a new inquiry dialog.

Method Summary

Modifier and Type	Method and Description
protected void	append(Markupable markupableToAppend) Appends a markupable to the same line as previously used.
protected void	append(java.lang.String stringToAppend) Appends a string to the same line as previously used.
protected void	append(java.lang.String label, java.lang.String stringToAppend) Appends a string to a new line with its describing label.
protected void	appendIfFilled(WhereCondition whereCondition, java.lang.String[] columnNames, java.lang.String searchString) Appends a fragment to the where condition.
protected void	appendIfFilled(WhereCondition whereCondition, java.lang.String[] columnNames, java.lang.String searchString, boolean wholeWord) Appends a fragment to the where condition.
protected HalfDataComboBox	createComboBox(java.lang.String label, DataObject sourceDataObject, java.lang.String visibleColumn) Creates a combo box in a new line with its describing label.
protected HalfDataComboBox	createComboBox(java.lang.String label, DataObject sourceDataObject, java.lang.String visibleColumn, java.lang.String orderByColumn) Creates a combo box in a new line with its describing label.
protected HalfDataComboBox	createComboBox(java.lang.String label, DataObject sourceDataObject, java.lang.String visibleColumn, java.lang.String orderByColumn, java.lang.String nameForNoChoice) Creates a combo box in a new line with its describing label.
protected MustDateField	createDateField(java.lang.String label, java.lang.String name) Creates a date input field in a new line with its describing label.
protected MustIntField	createIntField(java.lang.String label) Creates a int input field in the same line as previously used.
protected MustTextArea	createTextArea(java.lang.String label) Creates a text area in a new line with its describing label.
protected MustTextField	createTextField(int length) Creates a text input field in the same line as previously used.
protected MustTextField	createTextField(java.lang.String label, int length) Creates a text input field in a new line with its describing label.
protected void	createTextFieldForGlobalSearch(java.lang.String label, int length, DataObject dataObjectForGlobalSearch) Creates a new text field for global search.
protected MustTimeField	createTimeField(java.lang.String label, java.lang.String name) Creates a time input field in a new line with its describing label.
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.
protected void	free() Frees (releases) references caused by this frame, particularly static register entries.
AttributeList	getAttributeList() Returns the attribute list.
abstract java.lang.Class<? extends Invokable>	getDataListClass() Returns the class for listing data.
int	getStackMovement() Returns the wished stack movement.
Submission	getSubmission() Informs the next invokable in stack about the submission details.
java.lang.String	getTagSequence() Returns the default tag sequence (as HTML).
java.lang.String	getTitle() Returns the title of the property administration
protected abstract java.lang.String	getWhereCondition() Returns the where condition for the select statement to process the inquiry.
protected boolean	isInputAccepted() Returns true if user input is accepted.
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.
void	setTitle(java.lang.String title) Sets the title of the property administration
void	setToolTipText(java.lang.String toolTipText) Sets the tool tip text of the last added markupable.
boolean	wantToBeFinalized() Indicates whether the reuse of the invokable is not to be supported.
protected void	wholeWordSearchAppend(WhereCondition whereCondition, java.lang.String columnName, java.lang.String searchString) Appends a search as a whole word.
protected void	wholeWordSearchAppend(WhereCondition whereCondition, java.lang.String columnName, java.lang.String searchString, boolean startingWithOr) Appends a search as a whole word.

Methods inherited from class de.must.markup.Dialog

afterOutput, appendAdditionalButton, beforeOutput, destroy, finalize, getAdditionalButtons, getBackButtonTagSequence, getCancelButtonTagSequence, getFooter, getHeader, getHelpContext, getInvokableInAdvance, getOkButtonTagSequence, getScriptToExecute, getScriptToExecuteSequence, getSubTitle, init, isCancelable, isPost, isSuitableDialog, setHelpContext, setHelpContext, setMessageToKeep, setMessageToKeepIfNotAlreadySet, setScriptToExecute, setStackMovement, setSubTitle

Methods inherited from class java.lang.Object

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

Field Detail

currentAttributeList

protected AttributeList currentAttributeList

wantToBeFinalized

protected boolean wantToBeFinalized

globalSearchTextField

protected MustTextField globalSearchTextField

dataObjectForGlobalSearch

protected DataObject dataObjectForGlobalSearch

Constructor Detail

Enquiry

public Enquiry(SessionData sessionData)

Constructs a new inquiry dialog.

Parameters:

sessionData - the session's public data

Method Detail

setTitle

public void setTitle(java.lang.String title)

Sets the title of the property administration

Overrides:

setTitle in class Dialog

Parameters:

title - the title of the property administration

getTitle

public java.lang.String getTitle()

Returns the title of the property administration

Overrides:

getTitle in class Dialog

Returns:

the title of the property administration

setSubmitter

public 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

createTextField

protected MustTextField createTextField(int length)

Creates a text input field in the same line as previously used.

Parameters:

length - the length of the input fields to be created.

Returns:

the created text input field

createTextField

protected MustTextField createTextField(java.lang.String label,
                                        int length)

Creates a text input field in a new line with its describing label.

Parameters:

label - the line label

length - the length of the input fields to be created.

Returns:

the created text input field

createTextArea

protected MustTextArea createTextArea(java.lang.String label)

Creates a text area in a new line with its describing label.

Parameters:

label - the line label

Returns:

the created text area

createIntField

protected MustIntField createIntField(java.lang.String label)

Creates a int input field in the same line as previously used.

Parameters:

label - the line label

length - the length of the field

Returns:

the created int field

createDateField

protected MustDateField createDateField(java.lang.String label,
                                        java.lang.String name)

Creates a date input field in a new line with its describing label.

Parameters:

label - the line label

name - the name of the field

Returns:

the created date field

createTimeField

protected MustTimeField createTimeField(java.lang.String label,
                                        java.lang.String name)

Creates a time input field in a new line with its describing label.

Parameters:

label - the line label

name - the name of the field

Returns:

the created date field

createComboBox

protected HalfDataComboBox createComboBox(java.lang.String label,
                                          DataObject sourceDataObject,
                                          java.lang.String visibleColumn)

Creates a combo box in a new line with its describing label.

Parameters:

label - the line label.

sourceDataObject - the source data object that shall fill the content of the combo box

visibleColumn - the column to be used to fill the combo box from the source data object

Returns:

the created combo box

createComboBox

protected HalfDataComboBox createComboBox(java.lang.String label,
                                          DataObject sourceDataObject,
                                          java.lang.String visibleColumn,
                                          java.lang.String orderByColumn)

Creates a combo box in a new line with its describing label.

Parameters:

label - the line label.

sourceDataObject - the source data object that shall fill the content of the combo box

visibleColumn - the column to be used to fill the combo box from the source data object

orderByColumnName - the column name to determine for the list order

Returns:

the created combo box

createComboBox

protected HalfDataComboBox createComboBox(java.lang.String label,
                                          DataObject sourceDataObject,
                                          java.lang.String visibleColumn,
                                          java.lang.String orderByColumn,
                                          java.lang.String nameForNoChoice)

Creates a combo box in a new line with its describing label.

Parameters:

label - the line label.

sourceDataObject - the source data object that shall fill the content of the combo box

visibleColumn - the column to be used to fill the combo box from the source data object

orderByColumnName - the column name to determine for the list order

nameForNoChoice - the expression that indicates "no choice"

Returns:

the created combo box

createTextFieldForGlobalSearch

protected void createTextFieldForGlobalSearch(java.lang.String label,
                                              int length,
                                              DataObject dataObjectForGlobalSearch)

Creates a new text field for global search.

Parameters:

label - the line label

length - the length of the global search text field

append

protected void append(Markupable markupableToAppend)

Appends a markupable to the same line as previously used.

Parameters:

markupableToAppend - the markupable to append

append

protected void append(java.lang.String stringToAppend)

Appends a string to the same line as previously used.

Parameters:

stringToAppend - the string to append

append

protected void append(java.lang.String label,
                      java.lang.String stringToAppend)

Appends a string to a new line with its describing label.

Parameters:

label - the line label

stringToAppend - the string to append

setToolTipText

public void setToolTipText(java.lang.String toolTipText)

Sets the tool tip text of the last added markupable.

Parameters:

toolTipText - the tool tip text to set.

getAttributeList

public AttributeList getAttributeList()

Returns the attribute list.

Returns:

the attribute list

getTagSequence

public java.lang.String getTagSequence()

Returns the default tag sequence (as HTML). Normally you should not call this method directly. Use Layout implementing classes instead.

Returns:

the default tag sequence (as HTML)

See Also:

Layout

process

public void process(GeneralizedRequest request)

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

Specified by:

process in interface Invokable

Overrides:

process in class Dialog

Parameters:

request - the request to react to

isInputAccepted

protected boolean isInputAccepted()

Returns true if user input is accepted. Override this method to implement individual input checks.

Returns:

true if user input is accepted

getDataListClass

public abstract java.lang.Class<? extends Invokable> getDataListClass()

Returns the class for listing data.

Returns:

the class for listing data

fetchValuesFromRequest

public 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.

Specified by:

fetchValuesFromRequest in interface Invokable

Overrides:

fetchValuesFromRequest in class Dialog

Parameters:

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

See Also:

Markupable#fetchYourValueFromRequest

getSubmission

public 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

public 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.

Specified by:

getStackMovement in interface Invokable

Overrides:

getStackMovement in class Dialog

Returns:

the stack movement

wantToBeFinalized

public boolean wantToBeFinalized()

Indicates whether the reuse of the invokable is not to be supported.

Returns:

true if the reuse of the invokable is not to be supported

getWhereCondition

protected abstract java.lang.String getWhereCondition()

Returns the where condition for the select statement to process the inquiry. See subclass code for samples for samples how this may be implemented. In the simplest case it looks like return DbFieldName like '%" + UIfield.getText() + "%'";

Returns:

the where condition for the select statement

appendIfFilled

protected void appendIfFilled(WhereCondition whereCondition,
                              java.lang.String[] columnNames,
                              java.lang.String searchString)

Appends a fragment to the where condition. May be a part of a word.

Parameters:

whereCondition - the where condition to extend

columnNames - the columns to be used to search

searchString - the string to search

appendIfFilled

protected void appendIfFilled(WhereCondition whereCondition,
                              java.lang.String[] columnNames,
                              java.lang.String searchString,
                              boolean wholeWord)

Appends a fragment to the where condition.

Parameters:

whereCondition - the where condition to extend

columnNames - the columns to be used to search

searchString - the string to search

wholeWord - whether the expression is to be searched as a whole word

wholeWordSearchAppend

protected void wholeWordSearchAppend(WhereCondition whereCondition,
                                     java.lang.String columnName,
                                     java.lang.String searchString)

Appends a search as a whole word.

Parameters:

whereCondition - the where condition to extend

columnName - the name of the column to be searched in

searchString - the expression to be searched as a whole word

wholeWordSearchAppend

protected void wholeWordSearchAppend(WhereCondition whereCondition,
                                     java.lang.String columnName,
                                     java.lang.String searchString,
                                     boolean startingWithOr)

Appends a search as a whole word.

Parameters:

whereCondition - the where condition to extend

columnName - the name of the column to be searched in

searchString - the expression to be searched as a whole word

free

protected void free()

Description copied from class: Dialog

Frees (releases) references caused by this frame, particularly static register entries. To be called via destroy() to prevent multiple call. Override it to do additional releases and don't forget to call super.free() at the end.

Overrides:

free in class Dialog

See Also:

Dialog.free()