psdi.webclient.system.beans

Class ResultsBean

java.lang.Object

psdi.webclient.system.beans.WebClientBean

psdi.webclient.system.beans.DataBean

psdi.webclient.system.beans.ResultsBean

All Implemented Interfaces:

java.util.EventListener, javax.servlet.http.HttpSessionBindingListener, DataBeanListener

Direct Known Subclasses:

ASNProjectResultsBean, AssetResultsBean, CASNProjectResultsBean, CatalogResultsTableBean, CatalogTableBean, CreateLogBean, DMCollResultsBean, IntMsgTrkResultBean, InventoryResultsBean, InvIssueResultsBean, ItemResultsBean, MfMailCfgResultsBean, MRBean, RefCommResultsBean, SKDProjectResultsBean, StoreroomResultsBean, TableBean, UserResultsBean

public class ResultsBean
extends DataBean

Field Summary

Fields inherited from class psdi.webclient.system.beans.DataBean

ALL_BOOKMARKS, ALL_RECORDS, ATTR_COLUMN, ATTR_DEFAULT, ATTR_QBE, ATTR_READONLY, ATTR_REFRESH_TABLE, ATTR_REQUIRED, ATTR_RESET, MAX_TABLEROWS, TABLE_ALL_SELECTED, TABLE_AT_FIRST_PAGE, TABLE_AT_FIRST_ROW, TABLE_AT_LAST_PAGE, TABLE_AT_LAST_ROW, TABLE_DETAILS_EXPANDED, TABLE_EXPANDED, TABLE_FILTER_EXPANDED, TABLE_FILTERED, TABLE_REFRESH_ALL_ROWS, TABLE_REFRESH_FILTER, TABLE_REFRESH_ROW, TABLE_REFRESH_TITLE, TABLE_ROW_CHANGED, TABLE_START_EMPTY, TABLE_SUBSELECT_ON, TABLE_USE_SUBSELECT

Fields inherited from class psdi.webclient.system.beans.WebClientBean

EVENT_CONTINUE, EVENT_HANDLED, EVENT_STOP_ALL

Constructor Summary

Constructors

Constructor and Description
ResultsBean()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(DataBeanListener listener) Adds a listener (child DataBean) to this DataBean (parent).
boolean	allSelected() Returns boolean true if all records are selected
int	BOOKMARK()
void	clearBean()
int	clearfilter()
void	clearTableRetainCache() reset the cache used to track the list table state
int	fetchTableData()
int	findFirstSelectedIndex() Returns the index of the first selected mbo.
java.lang.String[][]	getDataAsArray(java.lang.String[] attributeNames) For the given list of attributes, this returns all rows of data in an array where the first level is the rows of data and the second level is the data for each of the attributes in that row.
void	getFirstRecord() Sets the ResultsSetBean to the first record in the reseult set (if there is one) This is called by the RecordMboSetBean, when it tries to get it's current record.
MboSetRemote	getMboSet() Returns the MboSetRemote of the DataBean.
boolean	getResetFromQbeclearInit()
java.lang.String[][]	getSelectedDataAsArray(java.lang.String[] attributeNames) For the given list of attributes, this returns just the selected rows of data, (if no rows are selected then all rows are used) in an array where the first level is the rows of data and the second level is the data for each of the attributes in that row.
boolean	hasRecChanged() Returns the recChanged flag.
boolean	hasRecordsForAction() Returns true if the ResultsBean has records to perform an action on.
boolean	isAppLockEnabled() Returns a boolean indicating if the app this bean is on is enabled for Record Locking
boolean	isModifiedRow(int thisRow) Track if the record is modified
boolean	isRowDeleted(int thisRow) Track if the record is deleted
boolean	next() Advances the current row position.
boolean	previous() Decrements the current row position.
void	recHasChanged() Called by the RecordMboSetBean when it is saved.
void	recHasChanged(int oper) Called by the RecordMboSetBean when it is saved.
void	reset() Resets the MboSet.
void	resetSelectedCache() Clears the selectedIndex array of all selected indexes.
void	save() Saves the changes made to the MboSet Throws MXException or RemoteException on failure The MboSet data or cached data will be undisturbed.
int	search()
void	select(int row) Marks the Mbo at the specified row Selected.
void	select(int startIndex, int count) Marks the a set of Mbos starting from startIndex selected.
void	selectAll() selects all Mbos on in the MboSet, remotely
int	selectrecord()
boolean	setCurrentRow(int nRow) Changes the current row position.
void	setPageRowCount(int rowCount)
void	setQbeDefaults() Overrided to always force the setting of default qbe values when called.
void	setResetFromQbeclearInit(boolean flag)
void	setStartEmpty()
void	setSubSetMaxRowCount(int maxrows) Set the maximun number of row the mboset can have when in subselect mode.
void	setupBean(SessionContext sc) Deprecated. FIREFOX
void	setupBean(WebClientSession wcs) This method must be call after the bean is instantiated.
int	togglesubselect() Sets the subeselect flag to determine if the results table is in subselect mode (using multi-select)
void	turnEmptyStateOff() Resets the start empty state flag off to allow the dean to fetch the data.
void	turnEmptyStateOff(boolean dofetch) Resets the start empty state flag off to allow the dean to fetch the data.
void	unselect(int row) Marks the Mbo at the specified row Unselected.
void	unselect(int startIndex, int count) Marks the a set of Mbos starting from startIndex Unselected.
void	unselectAll() Unselects all Mbos on in the MboSet, remotely
boolean	useSubSelect() Returns the usesubset flag which for determining if an action taken on the results set should be done on all records or just the selected ones.

Methods inherited from class psdi.webclient.system.beans.DataBean

_useAllBookmarksQuery, _useAllRecsQuery, _usequery, addAttribute, addConditionalProperties, addDialogReference, addQbeAttribute, addrow, addSigOption, applyValuesToSharedAttributes, applyValuesToSharedAttributes, asyncLocked, bindComponent, boundToTable, buildPortalMsg, callBeanMethod, callBeanMethod, callBeanMethod, callBeanMethod, callMethod, callMethod, callMethod, callMethod, callRemoteMethod, callRemoteMethod, cancelDialog, canCloseBean, canFetchData, changeRequiredField, checkAndDistributeRequiredError, checkESigAuthenticated, checkForAppError, checkMethodAccess, clearSavedFilterSettings, clearSavedQbeSettings, close, copytonewrow, count, dataChangedEvent, delete, delete, deleteAndRemove, deleteAndRemove, displaycount, duplicateMbo, execute, fetchRecordData, fetchTableData, filterrows, findAndCallMethod, fireChildChangedEvent, fireDataChangedEvent, fireDataChangedEvent, fireStructureChangedEvent, fireStructureChangedEvent, getAppWhere, getAttributes, getBoolean, getBoolean, getCacheRowIndex, getColumnDate, getColumnString, getCompleteWhere, getConditionalProperties, getCurrentQueryDescription, getCurrentQueryName, getCurrentRow, getDataAsArray, getDataList, getDataList, getDataList, getDataList, getDataListFromMboSetRemote, getDate, getDefaultOrderBy, getDefaultValue, getDescAttributeId, getEndRow, getEventRowIndex, getKeyAttribute, getKeyAttributes, getLastEventHandled, getLastFetchIndex, getList, getList, getList, getLockedByDisplayName, getMbo, getMbo, getMboForUniqueId, getMboName, getMboOrZombie, getMboRowIndex, getMboSetData, getMboSetFromSmartFind, getMboSetFromSmartFind, getMboSetFromSmartFind, getMboValueData, getMboValueData, getMboValueInfo, getMXSession, getNullRequiedFields, getOrderBy, getPageEndRow, getPageRowCount, getPageStartIndex, getParent, getQbe, getQbe, getQbeAttributes, getQueryDescBeforeReviseAction, getQueryNameBeforeReviseAction, getRemoteForDownload, getRemoteForLookup, getReturnAttribute, getReturnComponent, getReturnComponentId, getReturnControlId, getRowIndexFromEvent, getSelectedDataAsArray, getSelection, getShowDetails, getSmartFillValue, getSortOrder, getString, getString, getTableAttributes, getTableOffset, getTableStateFlags, getTitle, getUIERMEntity, getUniqueIdFromSmartFill, getUniqueIdFromSmartFill, getUniqueIdName, getUniqueIdValue, getUserAndQbeWhere, getUserWhere, getWarnings, getZombie, getZombieMboValueData, handleRemoteException, handleRequiredFieldException, hasLongDescriptionText, hasLongDescriptionText, hasMboSetRemote, hasPageRows, hasRow, hasSameMboSet, hasSigOptionAccess, hasSigOptionAccess, hierarchicalmove, highlightrow, highlightrow, insert, insert, insertAtEnd, instantdelete, isAppTableRetain, isAttribute, isAttributeHidden, isAttributeHidden, isColumnSorted, isEmpty, isListTableModified, isListTableRetain, isMboHidden, isMboHidden, isModifiedRow, isNewRow, isNewRow, isNewRowUnedited, isRowLocked, isSelected, isSubSelect, isTableAttribute, isTablePostionMarked, isTableRowSelected, isTableStateFlagSet, listenerChangedEvent, madeRequiredConditionally, markTablePosition, moveToMboFromDataBean, needToAuthenticate, nextrow, positionState, prevrow, propagateRequired, queryAllBookmarks, queryAllRecs, refreshFieldErrors, refreshTable, registerDynamicControlsWithERM, reloadTable, removeDialogReference, removeListener, removeRowOnCancel, rePosition, resetJSPFlags, resetQbe, resetWithSelection, restoreSavedQbeSettings, returnLookupValue, returnLookupValue, returnLookupValue, returnLookupValue, save, saveCurrentQbeSettings, scrollnext, scrollprev, selectRows, sendRefreshTable, setApp, setAppDefault, setAppDefaults, setApplicationError, setAppWhere, setAsyncLock, setAttributes, setCurrentQueryDescription, setDate, setDate, setDate, setDefaultOrderBy, setDefaultQbe, setDefaultValue, setDefaultValue, setDescAttributeId, setDynamicAppDefaults, setDynamicDefault, setDynamicQbeDefaults, setEmptyOnClear, setEsigValidated, setEventRowIndex, setfiltervalue, setLastEventHandled, setListTableModified, setListTableRetain, setMboName, setNewRowUnedited, setOrderBy, setParent, setQbe, setQbe, setQbe, setQbe, setQbe, setQbeAttributes, setQbeCaseSensitive, setQbeExactMatch, setQueryBySiteQbe, setQueryDescBeforeReviseAction, setQueryNameBeforeReviseAction, setRemoveOnCancel, setReturnAttribute, setReturnComponent, setReturnComponentId, setReturnControlId, setShowDetails, setSmartFillValue, setTableFlag, setUserDefaults, setUserWhere, setvalue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromComponent, smartFill, smartFill, sort, sort, sortcolumn, sortcolumn, sqlwhere, structureChangedEvent, toBeSaved, toggledeleterow, toggledetailstate, toggleselectallrows, toggleselectrow, toString, turnEmptyStateOn, unbindComponent, undelete, undelete, useAllBookmarksQuery, useAllRecsQuery, useqbe, usequery, useQuery, useStoredQuery, validate, validateChildren, validateMbo, valueBound, valueUnbound

Methods inherited from class psdi.webclient.system.beans.WebClientBean

getCreator, getId, setCreator, setId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ResultsBean

public ResultsBean()

Method Detail

addListener

public void addListener(DataBeanListener listener)

Adds a listener (child DataBean) to this DataBean (parent). relateField is the field in the parent that the child listens to so if just the field is changed then the listeners parentChanged methods will be call.

Overrides:

addListener in class DataBean

reset

public void reset()
           throws MXException

Resets the MboSet. Clears the internal cache and fires a structure change event to all listeners. Throws MXException or RemoteException on failure

Overrides:

reset in class DataBean

Throws:

MXException

recHasChanged

public void recHasChanged()

Called by the RecordMboSetBean when it is saved. Sets the setRecChanged flag which is checked by the TableTag for tables of type "results", to see if the mboSet needs to be reset in order for the changes to be seen in the table.

isAppLockEnabled

public boolean isAppLockEnabled()

Returns a boolean indicating if the app this bean is on is enabled for Record Locking

Returns:

hasRecChanged

public boolean hasRecChanged()

Returns the recChanged flag. True means the there have been changes and the MboSet needs to be refreshed to see them.

getMboSet

public MboSetRemote getMboSet()
                       throws MXException,
                              java.rmi.RemoteException

Returns the MboSetRemote of the DataBean. If there isn't a remote it will try and get one from the MXSession or parent Mbo (if there is one). This method should be overridden if there if the MboSetRemote needs to be obtained a different way.

Overrides:

getMboSet in class DataBean

Throws:

MXException

java.rmi.RemoteException

save

public void save()
          throws MXException

Saves the changes made to the MboSet Throws MXException or RemoteException on failure The MboSet data or cached data will be undisturbed.

Overrides:

save in class DataBean

Throws:

MXException

setCurrentRow

public boolean setCurrentRow(int nRow)
                      throws MXException,
                             java.rmi.RemoteException

Changes the current row position. Returns true, if the row exists in the result set otherwise false. Throws MXException or RemoteException on failure

Overrides:

setCurrentRow in class DataBean

Throws:

MXException

java.rmi.RemoteException

setSubSetMaxRowCount

public void setSubSetMaxRowCount(int maxrows)

Set the maximun number of row the mboset can have when in subselect mode.

resetSelectedCache

public void resetSelectedCache()

Clears the selectedIndex array of all selected indexes.

clearBean

public void clearBean()
               throws MXException,
                      java.rmi.RemoteException

Overrides:

clearBean in class DataBean

Throws:

MXException

java.rmi.RemoteException

getFirstRecord

public void getFirstRecord()

Sets the ResultsSetBean to the first record in the reseult set (if there is one) This is called by the RecordMboSetBean, when it tries to get it's current record.

search

public int search()
           throws MXException,
                  java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

selectrecord

public int selectrecord()
                 throws MXException,
                        java.rmi.RemoteException

Overrides:

selectrecord in class DataBean

Throws:

MXException

java.rmi.RemoteException

setPageRowCount

public void setPageRowCount(int rowCount)

Overrides:

setPageRowCount in class DataBean

togglesubselect

public int togglesubselect()
                    throws MXException,
                           java.rmi.RemoteException

Sets the subeselect flag to determine if the results table is in subselect mode (using multi-select)

Throws:

MXException

java.rmi.RemoteException

useSubSelect

public boolean useSubSelect()

Returns the usesubset flag which for determining if an action taken on the results set should be done on all records or just the selected ones.

select

public void select(int row)
            throws MXException

Marks the Mbo at the specified row Selected.

Overrides:

select in class DataBean

Throws:

MXException

unselect

public void unselect(int row)
              throws MXException

Marks the Mbo at the specified row Unselected.

Overrides:

unselect in class DataBean

Throws:

MXException

selectAll

public void selectAll()
               throws MXException

selects all Mbos on in the MboSet, remotely

Overrides:

selectAll in class DataBean

Throws:

MXException

unselect

public void unselect(int startIndex,
            int count)
              throws MXException

Marks the a set of Mbos starting from startIndex Unselected.

Overrides:

unselect in class DataBean

Parameters:

startIndex - starting index position (must be >= 0)

count - number of Mbos after the start index to be marked unselected (must be > 0).

Throws:

MXException

select

public void select(int startIndex,
          int count)
            throws MXException

Marks the a set of Mbos starting from startIndex selected.

Overrides:

select in class DataBean

Parameters:

startIndex - starting index position (must be >= 0)

count - number of Mbos after the start index to be marked unselected (must be > 0).

Throws:

MXException

unselectAll

public void unselectAll()
                 throws MXException

Unselects all Mbos on in the MboSet, remotely

Overrides:

unselectAll in class DataBean

Throws:

MXException

next

public boolean next()
             throws MXException

Advances the current row position. Fires a row change event to all listeners upon success. Throws MXException or RemoteException on failure

Overrides:

next in class DataBean

Throws:

MXException

previous

public boolean previous()
                 throws MXException

Decrements the current row position. Fires a row change event to all listeners upon success. Throws MXException or RemoteException on failure

Overrides:

previous in class DataBean

Throws:

MXException

findFirstSelectedIndex

public int findFirstSelectedIndex()

Returns the index of the first selected mbo.

allSelected

public boolean allSelected()

Returns boolean true if all records are selected

fetchTableData

public int fetchTableData()
                   throws MXException,
                          java.rmi.RemoteException

Overrides:

fetchTableData in class DataBean

Throws:

MXException

java.rmi.RemoteException

setupBean

public void setupBean(WebClientSession wcs)

Description copied from class: DataBean

This method must be call after the bean is instantiated. It tells the bean what it's clientSession is , the control that created the bean and the event that caused the creation of the bean. Also gets the values the orderyby, whereclause, apprestrictions, rowsperpage, and parentdatasrc properties from the control (the one that instantiated the bean) if any are set. Plus it gets the list of bound controls from the presentations control handler.

Overrides:

setupBean in class DataBean

setupBean

public void setupBean(SessionContext sc)

Deprecated. FIREFOX

Description copied from class: WebClientBean

TODO: Replace with setupBean (WebClientSession)

Overrides:

setupBean in class DataBean

hasRecordsForAction

public boolean hasRecordsForAction()
                            throws MXException

Returns true if the ResultsBean has records to perform an action on. Which means the List table is in sub-select mode and the user has selected records or the table is not in sub-select mode then see's if the ResultsBena has any records.

Returns:

Throws:

MXException

clearfilter

public int clearfilter()
                throws MXException

Overrides:

clearfilter in class DataBean

Throws:

MXException

BOOKMARK

public int BOOKMARK()
             throws MXException,
                    java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setStartEmpty

public void setStartEmpty()

turnEmptyStateOff

public void turnEmptyStateOff()
                       throws MXException,
                              java.rmi.RemoteException

Resets the start empty state flag off to allow the dean to fetch the data.

Throws:

MXException

java.rmi.RemoteException

turnEmptyStateOff

public void turnEmptyStateOff(boolean dofetch)
                       throws MXException,
                              java.rmi.RemoteException

Resets the start empty state flag off to allow the dean to fetch the data. If dofetch parameter is true then the first record will be fetched.

Throws:

MXException

java.rmi.RemoteException

getDataAsArray

public java.lang.String[][] getDataAsArray(java.lang.String[] attributeNames)

Description copied from class: DataBean

For the given list of attributes, this returns all rows of data in an array where the first level is the rows of data and the second level is the data for each of the attributes in that row. If there isn't data for a particular attribute in a row then "" is returned in the array for it's data. Also the first "row" in the array is the list of attributes used to retrieve the data for the array.

Overrides:

getDataAsArray in class DataBean

getSelectedDataAsArray

public java.lang.String[][] getSelectedDataAsArray(java.lang.String[] attributeNames)

Description copied from class: DataBean

For the given list of attributes, this returns just the selected rows of data, (if no rows are selected then all rows are used) in an array where the first level is the rows of data and the second level is the data for each of the attributes in that row. If there isn't data for a particular attribute in a row then "" is returned in the array for it's data. Also the first "row" in the array is the list of attributes used to retrieve the data for the array.

Overrides:

getSelectedDataAsArray in class DataBean

getResetFromQbeclearInit

public boolean getResetFromQbeclearInit()

setResetFromQbeclearInit

public void setResetFromQbeclearInit(boolean flag)

setQbeDefaults

public void setQbeDefaults()

Overrided to always force the setting of default qbe values when called.

Overrides:

setQbeDefaults in class DataBean

recHasChanged

public void recHasChanged(int oper)

Called by the RecordMboSetBean when it is saved. For tables of type "results", to see if the mboSet needs to be reset in order for the changes to be seen in the table. The state of the row changed is maintained in a hashmap. Only updates and deletes are tracked.In case of insert the refresh of table is bypassed but nothing is tracked.

Parameters:

oper - - ROW_INSERT,ROW_MODIFY,ROW_DELETE

clearTableRetainCache

public void clearTableRetainCache()

reset the cache used to track the list table state

isModifiedRow

public boolean isModifiedRow(int thisRow)

Track if the record is modified

Overrides:

isModifiedRow in class DataBean

Returns:

true or false

isRowDeleted

public boolean isRowDeleted(int thisRow)

Track if the record is deleted

Overrides:

isRowDeleted in class DataBean

Returns:

true or false