de.must.markup

Class DataList

java.lang.Object

de.must.markup.Dialog

de.must.markup.List

de.must.markup.DataList

All Implemented Interfaces:

Invokable

Direct Known Subclasses:

ColumnDataList, SimpleDataList

public abstract class DataList
extends List

Component for listing data to select entries for further processing. To avoid repeated database inquiry when control comes back from deeper stack invokables, the list is cached.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_BROWSE
static int	ACTION_COPY
static int	ACTION_DELETE
static int	ACTION_EDIT
static int	ACTION_NEW
protected DataObject	listDataObject
protected int	maxListEntries

Fields inherited from class de.must.markup.List

bottomText, listCache, listedRowCounter, submitter, title, 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
DataList(SessionData sessionData) Constructs a new data list.

Method Summary

Modifier and Type	Method and Description
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.
protected int	getAction() Returns the action to be retrieved by submitted invokable.
java.lang.String	getBrowseHref() Returns the HREF for browsing the entry.
java.lang.String	getCopyHref() Returns the HREF for copying the entry.
protected abstract java.lang.Class<? extends Invokable>	getDataAdministrationClass() Returns the class to proceed property administration for the entity listed here.
protected abstract java.lang.Class<? extends Invokable>	getDataPresentationClass() Returns the class to proceed property presentation for the entity listed here.
java.lang.String	getDeleteHref() Returns the HREF for deleting the entry.
java.lang.String	getEditHref() Returns the HREF for editing the entry.
protected java.lang.String	getElaboratedWhereCondition() Returns the where condition.
int	getLastProcessedActivityKey() Returns the ID of the action that was processed in a previous dialog step.
int	getMaxListEntries() Returns the maximum number of entries to be listed.
protected abstract java.lang.String	getOrderByFields() Returns the fields to be used for the order by clause, separated by comma as usual in SQL statements.
protected Identifier	getSelectedIdentifier() Returns the identifier (primary key) of the selected entry.
protected abstract java.lang.String	getSelectionFields() Returns the fields to be selected, separated by comma as usual in SQL statements.
Submission	getSubmission() Informs the next invokable in stack about the submission details.
protected java.lang.String	getWhereCondition() Returns the where condition for the select statement to process the inquiry.
boolean	hasSqlSyntaxError() Returns true if there is an SQL syntax error.
void	init() Initializes the invokable in order to reuse the component without garbage from the previous use.
boolean	isCopyable() Returns true if the entry may be copied by the current user.
boolean	isDeletable() Returns true if the entry may be deleted by the current user.
boolean	isEditable() Returns true if the entry may be edited by the current user.
boolean	isExtendable() Returns true if the current user may add entries.
boolean	isListCutted() Returns true if the list is cut.
boolean	isPresentable() Returns true if detail presentation is available.
boolean	isRowToListAvailable() Returns true if a row to list is available.
boolean	isShowhits() Returns the showhits.
boolean	isSuitableDialog(GeneralizedRequest request) Indicates whether the request fits to this dialog.
void	process(GeneralizedRequest request) Allows the invokable to react to the request.
protected void	setListDataObject(DataObject listDataObject) Sets the data object to be used for listing the inquiry result.
void	setMaxListEntries(int maxListEntries) Sets the maximum number of entries to be listed.
void	setShowhits(boolean showhits) Sets the showhits.
boolean	startListFromBeginning() Induces to start listing form beginning.
boolean	wantToBeFinalized() Indicates whether the reuse of the invokable is not to be supported.

Methods inherited from class de.must.markup.List

getBottomText, getListCache, getNbrOfRows, getRowString, getTitle, isListEmpty, setBottomText, setListCache, setSubmitter, setTitle

Methods inherited from class de.must.markup.Dialog

afterOutput, appendAdditionalButton, beforeOutput, destroy, finalize, getAdditionalButtons, getBackButtonTagSequence, getCancelButtonTagSequence, getFooter, getHeader, getHelpContext, getInvokableInAdvance, getOkButtonTagSequence, getScriptToExecute, getScriptToExecuteSequence, getStackMovement, getSubTitle, isCancelable, isPost, 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

ACTION_NEW

public static final int ACTION_NEW

See Also:

Constant Field Values

ACTION_BROWSE

public static final int ACTION_BROWSE

See Also:

Constant Field Values

ACTION_EDIT

public static final int ACTION_EDIT

See Also:

Constant Field Values

ACTION_COPY

public static final int ACTION_COPY

See Also:

Constant Field Values

ACTION_DELETE

public static final int ACTION_DELETE

See Also:

Constant Field Values

listDataObject

protected DataObject listDataObject

maxListEntries

protected int maxListEntries

Constructor Detail

DataList

public DataList(SessionData sessionData)

Constructs a new data list.

Parameters:

sessionData - the session's data to share

Method Detail

setMaxListEntries

public void setMaxListEntries(int maxListEntries)

Sets the maximum number of entries to be listed.

Parameters:

maxListEntries - the maximum number of entries to be listed

getMaxListEntries

public int getMaxListEntries()

Returns the maximum number of entries to be listed.

Returns:

the maximum number of entries to be listed

setShowhits

public void setShowhits(boolean showhits)

Sets the showhits.

Parameters:

showhits - The showhits to set

isShowhits

public boolean isShowhits()

Returns the showhits.

Returns:

boolean

init

public void init()

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

Specified by:

init in interface Invokable

Overrides:

init in class List

getSelectionFields

protected abstract java.lang.String getSelectionFields()

Returns the fields to be selected, separated by comma as usual in SQL statements. Is to be implemented by the subclass to guarantee availability for later usage. Sample: return DbField1, DbField2, DbField3;

Returns:

the fields to be selected

getWhereCondition

protected java.lang.String getWhereCondition()

Returns the where condition for the select statement to process the inquiry. See the code of subclasses of Enquiry 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

See Also:

Enquiry.getWhereCondition()

getOrderByFields

protected abstract java.lang.String getOrderByFields()

Returns the fields to be used for the order by clause, separated by comma as usual in SQL statements.

Returns:

the fields to be used for the order by clause

setListDataObject

protected void setListDataObject(DataObject listDataObject)

Sets the data object to be used for listing the inquiry result.

Parameters:

listDataObject - the data object to be used for listing

startListFromBeginning

public boolean startListFromBeginning()

Induces to start listing form beginning.

Specified by:

startListFromBeginning in class List

Returns:

true if no exception occurred

hasSqlSyntaxError

public boolean hasSqlSyntaxError()

Returns true if there is an SQL syntax error.

Returns:

true if there is an SQL syntax error

isRowToListAvailable

public boolean isRowToListAvailable()

Returns true if a row to list is available. A row is available if there is still an entry in the result set and the maximum of entries to list is not exceeded.

Specified by:

isRowToListAvailable in class List

Returns:

true if a row to list is available

isListCutted

public boolean isListCutted()

Returns true if the list is cut.

Returns:

true if the list is cut

getLastProcessedActivityKey

public int getLastProcessedActivityKey()

Returns the ID of the action that was processed in a previous dialog step. Useful to set focus on the list.

Returns:

the ID of the action that was processed in a previous dialog step

getBrowseHref

public java.lang.String getBrowseHref()

Returns the HREF for browsing the entry.

Returns:

Returns the HREF for browsing the entry

getEditHref

public java.lang.String getEditHref()

Returns the HREF for editing the entry.

Returns:

the HREF for editing the entry

getCopyHref

public java.lang.String getCopyHref()

Returns the HREF for copying the entry.

Returns:

the HREF for copying the entry

getDeleteHref

public java.lang.String getDeleteHref()

Returns the HREF for deleting the entry.

Returns:

the HREF for deleting the entry

isPresentable

public boolean isPresentable()

Returns true if detail presentation is available.

Returns:

true if detail presentation is available

isExtendable

public boolean isExtendable()

Returns true if the current user may add entries.

Returns:

true if the current user may add entries

isEditable

public boolean isEditable()

Returns true if the entry may be edited by the current user.

Returns:

true if the entry may be edited by the current user

isCopyable

public boolean isCopyable()

Returns true if the entry may be copied by the current user.

Returns:

true if the entry may be copied by the current user

isDeletable

public boolean isDeletable()

Returns true if the entry may be deleted by the current user.

Returns:

true if the entry may be deleted by the current user

isSuitableDialog

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

Specified by:

isSuitableDialog in interface Invokable

Overrides:

isSuitableDialog in class Dialog

Parameters:

request - the request to check

Returns:

true if the request fits to this dialog

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 List

Parameters:

request - the request to react to

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 List

Parameters:

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

See Also:

Markupable#fetchYourValueFromRequest

getElaboratedWhereCondition

protected java.lang.String getElaboratedWhereCondition()

Returns the where condition. For the moment equals to getWhereCondition.

Returns:

the where condition

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

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

getDataAdministrationClass

protected abstract java.lang.Class<? extends Invokable> getDataAdministrationClass()

Returns the class to proceed property administration for the entity listed here.

Returns:

the class to proceed property administration

getDataPresentationClass

protected abstract java.lang.Class<? extends Invokable> getDataPresentationClass()

Returns the class to proceed property presentation for the entity listed here.

Returns:

the class to proceed property presentation

getSelectedIdentifier

protected Identifier getSelectedIdentifier()

Returns the identifier (primary key) of the selected entry.

Returns:

the identifier (primary key) of the selected entry

getAction

protected int getAction()

Returns the action to be retrieved by submitted invokable.

Returns:

the action to be retrieved by submitted invokable

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.destroy()