| com.jcorporate.expresso.services.controller.dbmaint.DynamicCmd
 com.jcorporate.expresso.services.controller.dbmaint.ListBase
All known Subclasses: com.jcorporate.expresso.services.controller.dbmaint.List, com.jcorporate.expresso.services.controller.dbmaint.SearchList,
| ListBase | | abstract public class ListBase extends DynamicCmd (Code) | | Base class for the DBMaint commands that display lists of records, such
as Search and List.
author:
Michael Nash |
| Method Summary | |
| protected void | addRecordsToBlock(ArrayList i_AllRecords, Block myTable)
Given an interator containing database objects add all of those
objects to the given output block as rows. | | protected Block | generatePageTransitions(ControllerRequest request, RecordPaginator rp, int pageLimit)
Generates an arrayList of transitions to allow direct jumping to a page.
Parameters:
request - The controllerRequest object so we can set the appropriateparameters from the previous page.
Parameters:
rp - a queried and instantiated RecordPaginator object
Parameters:
pageLimit - the maximum number of records per screen. | | protected RecordPaginator | getRecordPaginator()
| | protected String | getSortKey()
This method determines how the list is sorted. | | protected long | listRecords(String sortKey, Block myTable)
Lists the records for display
Parameters:
sortKey - The key to sort against
Parameters:
myTable - The Block to insert the table into. | | protected void | setupListSearchCriteria()
This method sets the search conditions on the current DBObject. | | protected void | showList()
|
| ListBase | | public ListBase()(Code) | | |
| ListBase | | public ListBase(String code, String descrip)(Code) | | Constructor
Parameters:
code - The name of the state.
Parameters:
descrip - The friendly name of the state |
| addRecordsToBlock | | protected void addRecordsToBlock(ArrayList i_AllRecords, Block myTable) throws DBException, ControllerException(Code) | | Given an interator containing database objects add all of those
objects to the given output block as rows. All non-secret
fields of each object should be added to the row.
Parameters:
i_AllRecords - an arrayList of DBObjects to add to the specified block
Parameters:
myTable - the Block obejct to add the records to.
throws:
DBException - upon error communicating with the DBObjects
throws:
ControllerException - upon other error. |
| generatePageTransitions | | protected Block generatePageTransitions(ControllerRequest request, RecordPaginator rp, int pageLimit) throws ControllerException(Code) | | Generates an arrayList of transitions to allow direct jumping to a page.
Parameters:
request - The controllerRequest object so we can set the appropriateparameters from the previous page.
Parameters:
rp - a queried and instantiated RecordPaginator object
Parameters:
pageLimit - the maximum number of records per screen. Block of Transition objects.
throws:
IllegalArgumentException - if isCountRecords() == false orif no search has been run yet.
throws:
ControllerException - upon all other errors |
| getSortKey | | protected String getSortKey() throws DBException, ControllerException(Code) | | This method determines how the list is sorted. The default sort order
is by the key fields of the underlying DBObject. To change the
default just override this method in a derived class.
String the sort key coded with pipes.
throws:
DBException - upon error communicating with the DBObject
throws:
ControllerException - upon other errors |
| listRecords | | protected long listRecords(String sortKey, Block myTable) throws DBException, ControllerException(Code) | | Lists the records for display
Parameters:
sortKey - The key to sort against
Parameters:
myTable - The Block to insert the table into. the total number of records listed
throws:
DBException - Upon error communicating with the DBObject
throws:
ControllerException - upon other errors |
| setupListSearchCriteria | | protected void setupListSearchCriteria() throws DBException, ControllerException(Code) | | This method sets the search conditions on the current DBObject.
The implementation at this level uses the searchParam if it has
been set, you can override this method to use other criteria,
like a custom where clause.
throws:
DBException - upon error communicating with the DBObject
throws:
ControllerException - upon other errors |
| showList | | protected void showList() throws DBException, ControllerException(Code) | | Base class
Show a list of database records to the user, allowing the key
to be clicked on to request an edit of the object
throws:
DBException - If a problem occurs retrieving the list |
| Methods inherited from com.jcorporate.expresso.services.controller.dbmaint.DynamicCmd | protected void addParams(Transition t) throws ControllerException(Code)(Java Doc)
protected String decode(String orig)(Code)(Java Doc)
protected String getControllerName() throws ControllerException(Code)(Java Doc)
protected DBObject getCurrentDBObj() throws ControllerException(Code)(Java Doc)
protected DataObject getDataObject() throws ControllerException(Code)(Java Doc)
protected String getFieldsParam() throws ControllerException(Code)(Java Doc)
protected Map getFixedFields() throws ControllerException(Code)(Java Doc)
protected String getKeyParameter(DataObject srcDBObj) throws ControllerException(Code)(Java Doc)
protected DataObject getMyDataObject()(Code)(Java Doc)
public int getPageNumber() throws ControllerException(Code)(Java Doc)
protected String getSearchParam() throws ControllerException(Code)(Java Doc)
protected void initializeDBObj() throws ControllerException(Code)(Java Doc)
protected boolean isKeyField(String fieldName) throws DBException, ControllerException(Code)(Java Doc)
protected DataObject retrieveMyDBObject() throws DBException, ControllerException(Code)(Java Doc)
public void run(ControllerRequest newParams, ControllerResponse newResponse) throws ControllerException, NonHandleableException(Code)(Java Doc)
protected void setFields(DataObject myDBObj, String fieldPairs) throws DBException(Code)(Java Doc)
protected void setFieldsParam(String newParam)(Code)(Java Doc)
protected void setMyDataObject(DataObject myDBObj)(Code)(Java Doc)
protected void setSearchParam(String newParam)(Code)(Java Doc)
protected void showBlobViewLink(String fieldName, DataObject dbobj, Input myElement, String controller) throws DBException, ControllerException(Code)(Java Doc)
protected synchronized void showEditLink(String fieldName, String oneFieldValue, DataObject currentRecord, Output myElement) throws DBException, ControllerException(Code)(Java Doc)
protected synchronized void showEditLink(String fieldName, String oneFieldValue, DataObject currentRecord, Output myElement, String controller) throws DBException, ControllerException(Code)(Java Doc)
protected void showOptions() throws DBException, ControllerException(Code)(Java Doc)
protected void showUserName(String theDescrip) throws ControllerException(Code)(Java Doc)
|
|
|