GLNavigatorDialogBean (Maximo API)

java.lang.Object
- psdi.webclient.system.beans.WebClientBean
- - psdi.webclient.system.beans.DataBean
  - - psdi.webclient.beans.common.GLNavigatorDialogBean

All Implemented Interfaces:

java.util.EventListener, javax.servlet.http.HttpSessionBindingListener, DataBeanListener
```
public class GLNavigatorDialogBean
extends DataBean
```

Field Summary

Fields
Modifier and Type Field and Description

GLNavigatorComboboxBean comboboxBean

boolean firstTime

java.lang.String orgAttribute
- Fields inherited from class psdi.webclient.system.beans.DataBean
  ALL_BOOKMARKS, ALL_RECORDS, alwaysSelected, app, appDefaultValues, appName, appWhere, ATTR_COLUMN, ATTR_DEFAULT, ATTR_QBE, ATTR_READONLY, ATTR_REFRESH_TABLE, ATTR_REQUIRED, ATTR_RESET, attributes, boundAttributes, boundInputs, closingBean, conditionallyRequired, creatingEvent, currentQuery, currentQueryDescription, currentRecordData, currentRow, defaultDynamicQbe, defaultOrderBy, defaultQbe, defaultUserValues, descAttributeId, designerMboName, dialogReferences, dynamicDefaults, emptyOnClear, ermEntity, esigvalidated, eventrow, fetchData, globalAppTableRetain, hasTableData, hasUnappliedAppDefaults, hasUnappliedQbeDefaults, keyAttribute, keyAttributes, lastEventHandled, lastfetchedindex, listeners, listTableModified, listTableRetain, LOG_CATEGORY, MAX_TABLEROWS, mboName, mbosetfromzombie, mboSetRemote, multiQbe, newRowUnedited, orderBy, parent, parentRelationship, propCache, qbeAttributes, qualrestrict, queryDescBeforeReviseAction, queryNameBeforeReviseAction, refreshList, refreshQbe, removeOnCancel, requiredFields, resetList, resetRemote, returnAttribute, returnComponent, returnComponentlId, ROW_DELETE, ROW_IGNORE, ROW_INSERT, ROW_MODIFY, rowsperpage, saveCount, savedFilterSettings, savedQbeAttributes, screenDesignMode, smartFillValue, startEmpty, startrow, 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, tableAttributes, tableData, tableDataInvalid, tableStateFlags, userQbeNotCommited, userWhereClause, zombieData
- Fields inherited from class psdi.webclient.system.beans.WebClientBean
  clientSession, creator, EVENT_CONTINUE, EVENT_HANDLED, EVENT_STOP_ALL, id, sessionContext

Fields
Modifier and Type	Field and Description
`GLNavigatorComboboxBean`	`comboboxBean`
`boolean`	`firstTime`
`java.lang.String`	`orgAttribute`

Constructor Summary

Constructors
Constructor and Description

GLNavigatorDialogBean()

Constructors
Constructor and Description
`GLNavigatorDialogBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`cancelDialog()` Called by the dialog control when the dialog is cancled.
`void`	`clearData()` Clears data for the table.
`int`	`execute()` Handle when user clicks the done button.
`void`	`fetchOrgAndSiteIdFromSource()` Retrieves Org and Site from source.
`GLFormat`	`getCurrentGLFormat()` Returns the current state in GLFormat.
`int`	`getCurrentSegment()` Allows the caller to determine which segment is currently selected
`java.lang.String`	`getPlaceHolder()`
`int`	`getSegmentCount()` Returns the number of segments in the loaded gl format
`char`	`getSegmentDelimiter(int segment)` Returns the delimiter character for the requested sement, according to the loaded gl format
`java.lang.String`	`getSegmentName(int segment)` Provides access to the name of the requested segment, according to the loaded gl format.
`java.lang.String`	`getSegmentPlaceHolder()` Returns the placeholder character used by the loaded gl format to pad a null gl segment value
`int`	`getSegmentSize(int segment)` Returns the number of characters in the requested segment value
`java.lang.String`	`getSegmentValue(int segment)` Provides access to the text value of a given segment.
`protected void`	`initialize()` Typically called after the DataBean gets a new MboSetRemote On the MboSetRemote it sets the app, the app defaults, user defaults If the remote is an instanceof NonPersistentMboSetRemote then setup is called on it and sets the current row to 0.
`int`	`refreshGL()` Handle when the user clears a segment.
`void`	`refreshGLData(GLNavigatorSelectOrgBean orgBean)` Based on current ORGID and current segment, it refreshs accounts.
`void`	`setCurrentSegment(int i)`
`void`	`setOrgId(java.lang.String newOrgId)` Sets the orgid to be used for fetching GLComponents
`int`	`setsegment()` Handle the case where a segment is clicked.
`int`	`setsegmentvalue()` Handle when the user has selected a segment value.
`void`	`structureChangedEvent(DataBean speaker)` Overridden to refresh FL components when OrgID changes
`boolean`	`validateComponent(java.lang.String compVal)` Returns the whether a particular component is valid or not

Methods inherited from class psdi.webclient.system.beans.DataBean
_useAllBookmarksQuery, _useAllRecsQuery, _usequery, addAttribute, addConditionalProperties, addDialogReference, addListener, addQbeAttribute, addrow, addSigOption, afterSetValue, applyValuesToSharedAttributes, applyValuesToSharedAttributes, asyncLocked, bindComponent, boundToTable, buildPortalMsg, callBeanMethod, callBeanMethod, callBeanMethod, callBeanMethod, callMethod, callMethod, callMethod, callMethod, callRemoteMethod, callRemoteMethod, canCloseBean, canFetchData, changeRequiredField, checkAndDistributeRequiredError, checkESigAuthenticated, checkForAppError, checkMethodAccess, cleanup, clearBean, clearfilter, clearQbeAttributes, clearSavedFilterSettings, clearSavedQbeSettings, close, copytonewrow, count, dataChangedEvent, delete, delete, deleteAndRemove, deleteAndRemove, displaycount, duplicateMbo, fetchRecordData, fetchTableData, fetchTableData, filterrows, findAndCallMethod, fireChildChangedEvent, fireDataChangedEvent, fireDataChangedEvent, fireStructureChangedEvent, fireStructureChangedEvent, getAppWhere, getAttributes, getBoolean, getBoolean, getCacheRowIndex, getColumnDate, getColumnString, getCompleteWhere, getConditionalProperties, getCurrentQueryDescription, getCurrentQueryName, getCurrentRow, getDataAsArray, 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, getMboSet, getMboSetData, getMboSetFromSmartFind, getMboSetFromSmartFind, getMboSetFromSmartFind, getMboSetRemote, getMboValueData, getMboValueData, getMboValueInfo, getMXSession, getNullRequiedFields, getOrderBy, getPageEndRow, getPageRowCount, getPageStartIndex, getParent, getParentRelationship, getQbe, getQbe, getQbeAttributes, getQueryDescBeforeReviseAction, getQueryNameBeforeReviseAction, getRemoteForDownload, getRemoteForLookup, getReturnAttribute, getReturnComponent, getReturnComponentId, getReturnControlId, getRowIndexFromEvent, getSavedFilterSettings, getSelectedDataAsArray, getSelectedDataAsArray, getSelection, getShowDetails, getSmartFillValue, getSortOrder, getString, getString, getTableAttributes, getTableOffset, getTableStateFlags, getTitle, getUIERMEntity, getUniqueIdFromSmartFill, getUniqueIdFromSmartFill, getUniqueIdName, getUniqueIdValue, getUserAndQbeWhere, getUserWhere, getWarnings, getWorkflowDirections, getZombie, getZombieMboValueData, handleRemoteException, handleRequiredFieldException, hasLongDescriptionText, hasLongDescriptionText, hasMboSetRemote, hasPageRows, hasRow, hasSameMboSet, hasSigOptionAccess, hasSigOptionAccess, hierarchicalmove, highlightrow, highlightrow, insert, insert, insertAtEnd, instantdelete, invalidateTableData, isAppTableRetain, isAttribute, isAttributeHidden, isAttributeHidden, isColumnSorted, isEmpty, isListTableModified, isListTableRetain, isLookupMultiSelect, isMboHidden, isMboHidden, isMboSetSame, isModifiedRow, isModifiedRow, isNewRow, isNewRow, isNewRowUnedited, isRowDeleted, isRowLocked, isSelected, isSubSelect, isTableAttribute, isTablePostionMarked, isTableRowSelected, isTableStateFlagSet, listenerChangedEvent, madeRequiredConditionally, markTablePosition, moveTo, moveToMboFromDataBean, needToAuthenticate, next, nextrow, notExist, positionState, preSaveChecks, previous, prevrow, propagateRequired, queryAllBookmarks, queryAllRecs, refreshFieldErrors, refreshTable, registerDynamicControlsWithERM, reloadTable, removeDialogReference, removeListener, removeRowOnCancel, rePosition, reserveOnePair, reset, resetDataBean, resetJSPFlags, resetQbe, resetWithSelection, restoreSavedQbeSettings, retainPosition, returnLookupValue, returnLookupValue, returnLookupValue, returnLookupValue, save, save, saveCurrentQbeSettings, scrollnext, scrollprev, select, select, selectAll, selectrecord, selectRows, sendRefreshTable, setApp, setApp, setAppDefault, setAppDefaults, setApplicationError, setAppWhere, setAsyncLock, setAttributes, setCurrentQueryDescription, setCurrentQueryName, setCurrentRecordData, setCurrentRow, setDate, setDate, setDate, setDefaultOrderBy, setDefaultQbe, setDefaultValue, setDefaultValue, setDescAttributeId, setDynamicAppDefaults, setDynamicDefault, setDynamicQbeDefaults, setEmptyOnClear, setERMOnMboSet, setEsigValidated, setEventRowIndex, setfiltervalue, setLastEventHandled, setListTableModified, setListTableRetain, setMboName, setNewRowUnedited, setOrderBy, setPageRowCount, setParent, setQbe, setQbe, setQbe, setQbe, setQbe, setQbeAttributes, setQbeCaseSensitive, setQbeDefaults, setQbeExactMatch, setQueryBySiteQbe, setQueryDescBeforeReviseAction, setQueryNameBeforeReviseAction, setRemoveOnCancel, setReturnAttribute, setReturnComponent, setReturnComponentId, setReturnControlId, setShowDetails, setSmartFillValue, setTableFlag, setupBean, setupBean, setupNonPersistent, setUserDefaults, setUserWhere, setvalue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromComponent, smartFill, smartFill, sort, sort, sortcolumn, sortcolumn, sqlwhere, toBeSaved, toggledeleterow, toggledetailstate, toggleselectallrows, toggleselectrow, toString, turnEmptyStateOn, unbindComponent, undelete, undelete, unselect, unselect, unselectAll, useAllBookmarksQuery, useAllRecsQuery, useqbe, usequery, useQuery, useStoredQuery, validate, validateChildren, validateClause, validateMbo, validateRow, valueBound, valueUnbound

Methods inherited from class psdi.webclient.system.beans.WebClientBean
getCreator, getId, setCreator, setId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - comboboxBean
```
public GLNavigatorComboboxBean comboboxBean
```
  - orgAttribute
```
public java.lang.String orgAttribute
```
  - firstTime
```
public boolean firstTime
```
- Constructor Detail
  - GLNavigatorDialogBean
```
public GLNavigatorDialogBean()
```
- Method Detail
  - initialize
```
protected void initialize()
                   throws MXException,
                          java.rmi.RemoteException
```
    Description copied from class: DataBean
    
    Typically called after the DataBean gets a new MboSetRemote On the MboSetRemote it sets the app, the app defaults, user defaults If the remote is an instanceof NonPersistentMboSetRemote then setup is called on it and sets the current row to 0. If the DataBean isn't bound to a table then initialize fetches the first mbo (sets the current row to 0). If this method is overridden under most case you will want to call super.initalize at the end of the the new initialize method.
    
    Overrides:
    
    initialize in class DataBean
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - execute
```
public int execute()
            throws MXException,
                   java.rmi.RemoteException
```
    Handle when user clicks the done button. Should assemble the glaccount using the glformat, and write the account to the target mbo
    
    Overrides:
    
    execute in class DataBean
    
    Parameters:
    
    column - name where the resulting glaccount is to be stored
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - cancelDialog
```
public int cancelDialog()
                 throws MXException,
                        java.rmi.RemoteException
```
    Description copied from class: DataBean
    
    Called by the dialog control when the dialog is cancled. Override this method if any special processing needs to be done when the user closes a dialog.
    
    Overrides:
    
    cancelDialog in class DataBean
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - setsegment
```
public int setsegment()
               throws MXException,
                      java.rmi.RemoteException
```
    Handle the case where a segment is clicked. Should load the list of gl components based on the currently selected segment
    
    Parameters:
    
    the - string parameter taken from the http request containing the index of the clicked segment
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - setsegmentvalue
```
public int setsegmentvalue()
                    throws MXException,
                           java.rmi.RemoteException
```
    Handle when the user has selected a segment value. Should add the selected component to segmentValues[].
    
    Parameters:
    
    value - of the selected segment
    
    Returns:
    
    true if there is a next segment, false if we're at the last segment
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - refreshGL
```
public int refreshGL()
              throws MXException,
                     java.rmi.RemoteException
```
    Handle when the user clears a segment. Sets the currently selected segment to null, and stay on the segment. Also clears all the segments next to the current segment.
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getPlaceHolder
```
public java.lang.String getPlaceHolder()
```
  - getCurrentGLFormat
```
public GLFormat getCurrentGLFormat()
                            throws MXException
```
    Returns the current state in GLFormat.
    
    Throws:
    
    MXException
  - getCurrentSegment
```
public int getCurrentSegment()
```
    Allows the caller to determine which segment is currently selected
    
    Returns:
    
    the zero based index of the currently selected segment.
  - getSegmentValue
```
public java.lang.String getSegmentValue(int segment)
```
    Provides access to the text value of a given segment. If the segment is null, the function returns an appropriately sized placeholder
    
    Returns:
    
    the gl formatted value of the requested segment
  - getSegmentName
```
public java.lang.String getSegmentName(int segment)
```
    Provides access to the name of the requested segment, according to the loaded gl format.
    
    Returns:
    
    the name of the segment (same as glconfigure.comptext)
  - getSegmentSize
```
public int getSegmentSize(int segment)
```
    Returns the number of characters in the requested segment value
    
    Returns:
    
    length of the segment string (same as glconfigure.gllength)
  - getSegmentDelimiter
```
public char getSegmentDelimiter(int segment)
```
    Returns the delimiter character for the requested sement, according to the loaded gl format
    
    Returns:
    
    delimiter character, typically a '-'
  - getSegmentCount
```
public int getSegmentCount()
```
    Returns the number of segments in the loaded gl format
    
    Returns:
    
    numeric count of gl segments in the glformat
  - getSegmentPlaceHolder
```
public java.lang.String getSegmentPlaceHolder()
```
    Returns the placeholder character used by the loaded gl format to pad a null gl segment value
    
    Returns:
    
    placeholder character, usually a '?'
  - validateComponent
```
public boolean validateComponent(java.lang.String compVal)
                          throws MXException,
                                 java.rmi.RemoteException
```
    Returns the whether a particular component is valid or not
    
    Returns:
    
    boolean if a component is valid or not.
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - refreshGLData
```
public void refreshGLData(GLNavigatorSelectOrgBean orgBean)
                   throws MXException,
                          java.rmi.RemoteException
```
    Based on current ORGID and current segment, it refreshs accounts.
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - setOrgId
```
public void setOrgId(java.lang.String newOrgId)
```
    Sets the orgid to be used for fetching GLComponents
    
    Parameters:
    
    newOrgId -
  - clearData
```
public void clearData()
               throws MXException
```
    Clears data for the table.
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - fetchOrgAndSiteIdFromSource
```
public void fetchOrgAndSiteIdFromSource()
```
    Retrieves Org and Site from source. It first tries to find out a mapped org id i.e in Incidents, RELEVENT ORGID is ASSETORGID, so use that one. If that is not present then, use orgid. If SITEID field exists for the source, retrieve it.
  - structureChangedEvent
```
public void structureChangedEvent(DataBean speaker)
```
    Overridden to refresh FL components when OrgID changes
    
    Specified by:
    
    structureChangedEvent in interface DataBeanListener
    
    Overrides:
    
    structureChangedEvent in class DataBean
    
    See Also:
    
    DataBeanListener.structureChangedEvent(psdi.webclient.system.beans.DataBean)
  - setCurrentSegment
```
public void setCurrentSegment(int i)
```

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

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

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

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

Methods inherited from class java.lang.Object

comboboxBean

orgAttribute

firstTime

GLNavigatorDialogBean

initialize

execute

cancelDialog

setsegment

setsegmentvalue

refreshGL

getPlaceHolder

getCurrentGLFormat

getCurrentSegment

getSegmentValue

getSegmentName

getSegmentSize

getSegmentDelimiter

getSegmentCount

getSegmentPlaceHolder

validateComponent

refreshGLData

setOrgId

clearData

fetchOrgAndSiteIdFromSource

structureChangedEvent

setCurrentSegment