TreeControlBean (Maximo API)

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AppContentTreeBean, AssociateClassificationBean, AssociateSpecBean, AttributeTreeBean, CategoryTreeBean, ClassDefaultLookupBean, CommentTreeBean, ComputerSystemDrilldownTreeBean, DMMapRulesTreeBean, DMMapTreeBean, DMTreeBean, DrilldownTreeBean, ParentObjectNameTreeBean, RelationshipTreeBean, RSConfigRelatedMboTreeBean, SearchClassificationBean, SearchSpecBean, SecurityProfileTreeBean, SelectParentClassificationBean, SystemsTreeBean, TreeBean, WOTreeBaseBean, WOTreeBaseBeanToo, WSIOAttributesTreeBean, WSIOTreeBean
```
public class TreeControlBean
extends DataBean
```
Custom databean to handle tree control/s specified in the dialogs and other pages containing tree controls.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`ignoreTreeRefresh`
`protected java.lang.String`	`objectname`
`protected boolean`	`refreshTree`
`protected java.lang.String`	`uniqueidname`
`protected java.lang.String`	`uniqueidvalue`

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

Constructor Summary

Constructors
Constructor and Description

TreeControlBean()

Constructors
Constructor and Description
`TreeControlBean()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`clearbreadcrumbs()`
`void`	`dataChangedEvent(DataBean speaker)` Overriden
`Tree`	`getBoundTree()` Returns the tree control bound to this bean
`java.util.ArrayList`	`getBreadcrumbs()` Skeleon method which can be implemented to return an array list of breadcrumbs expected by the Breadcrums control.
`java.lang.Object[][]`	`getChildren(java.lang.String objectname, java.lang.String uniqueid, java.lang.String[] dataattributes, int maxchildren)` Gets childnre for a given node
`java.lang.Object[]`	`getMboValueData(java.lang.String[] dataattributes)` Gets data a for givens et of attributes from the current mbo
`java.lang.String`	`getobjectname()` Returns Object name
`java.lang.Object[][]`	`getPathToTop(java.lang.String objectname, java.lang.String uniqueid, java.lang.String[] dataattributes, int maxchildren)` Gets Path to Top for a given node
`boolean`	`getRefreshTree()`
`java.lang.String`	`getSourceAttributeValue()`
`java.lang.String`	`getSourceDataAttribute()`
`java.lang.Object[][]`	`getTop(java.lang.String[] dataattributes, int maxchildren)` Gets the top nodes for the tree structure.
`java.lang.String`	`getuniqueidname()` Returns uniqueidname
`java.lang.String`	`getuniqueidvalue()` Returns uniqueidvalue
`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.
`void`	`markTreesForRefresh(java.lang.String dontRefreshMe)` Marks all trees on current page to be refreshed except this one when next render come around to this one.
`int`	`selectnode()` Handles the selectnode event fired from the frontend or through TreeNode It gets MBo for the uniqueid passed whena a node is selected
`int`	`selectrecord()` Handles the selectrecord event fired from the frontend (non-Javadoc)
`void`	`setcurrentnode(java.lang.String newobjectname, java.lang.String newuniqueidname, java.lang.String newuniqueidvalue)` Sets the current node using the objectname, new uniqueidname and its value.
`void`	`setHierarchy(java.lang.String objectname, java.lang.String uniqueid, java.lang.String hierarchy)` Sets the reference point for starting of the hierarchy
`void`	`setIgnoreTreeRefresh(boolean ignoreTreeRefresh)` Flag to avoid calling markTreesForRefresh
`void`	`setobjectname(java.lang.String newobjectname)` Sets objectname
`void`	`setRefreshTree(boolean flag)` Sets flag for tree refresh
`void`	`setSourceAttributeValue(java.lang.String sourceAttributevalue)` Sets new source attribute
`void`	`setSourceDataAttribute(java.lang.String sourceDataattribute)` Sets new source data attribute
`void`	`setuniqueidname(java.lang.String newuniqueidname)` Sets uniqueidname
`void`	`setuniqueidvalue(java.lang.String newuniqueidvalue)` Sets uniqueidvalue
`protected void`	`storeProperties()` Called from DrillDownBean to store information for the hierarchy.

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, cancelDialog, canCloseBean, canFetchData, changeRequiredField, checkAndDistributeRequiredError, checkESigAuthenticated, checkForAppError, checkMethodAccess, cleanup, clearBean, clearfilter, clearQbeAttributes, clearSavedFilterSettings, clearSavedQbeSettings, close, copytonewrow, count, delete, delete, deleteAndRemove, deleteAndRemove, displaycount, duplicateMbo, execute, 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, 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, structureChangedEvent, 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
  - objectname
```
protected java.lang.String objectname
```
  - uniqueidname
```
protected java.lang.String uniqueidname
```
  - uniqueidvalue
```
protected java.lang.String uniqueidvalue
```
  - refreshTree
```
protected boolean refreshTree
```
  - ignoreTreeRefresh
```
protected boolean ignoreTreeRefresh
```
- Constructor Detail
  - TreeControlBean
```
public TreeControlBean()
```
- 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
  - selectrecord
```
public int selectrecord()
                 throws MXException,
                        java.rmi.RemoteException
```
    Handles the selectrecord event fired from the frontend (non-Javadoc)
    
    Overrides:
    
    selectrecord in class DataBean
    
    Returns:
    
    EVENT_HANDLED;
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
    
    See Also:
    
    DataBean.selectrecord()
  - selectnode
```
public int selectnode()
               throws MXException,
                      java.rmi.RemoteException
```
    Handles the selectnode event fired from the frontend or through TreeNode It gets MBo for the uniqueid passed whena a node is selected
    
    Returns:
    
    EVENT_HANDLED;
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - setcurrentnode
```
public void setcurrentnode(java.lang.String newobjectname,
                           java.lang.String newuniqueidname,
                           java.lang.String newuniqueidvalue)
                    throws MXException,
                           java.rmi.RemoteException
```
    Sets the current node using the objectname, new uniqueidname and its value.
    
    Parameters:
    
    newobjectname -
    
    newuniqueidname -
    
    newuniqueidvalue -
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException - Apr 16, 2007
  - getTop
```
public java.lang.Object[][] getTop(java.lang.String[] dataattributes,
                                   int maxchildren)
                            throws MXException,
                                   java.rmi.RemoteException
```
    Gets the top nodes for the tree structure.
    
    Parameters:
    
    dataattributes -
    
    maxchildren -
    
    Returns:
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException - Apr 16, 2007
  - getChildren
```
public java.lang.Object[][] getChildren(java.lang.String objectname,
                                        java.lang.String uniqueid,
                                        java.lang.String[] dataattributes,
                                        int maxchildren)
                                 throws MXException,
                                        java.rmi.RemoteException
```
    Gets childnre for a given node
    
    Parameters:
    
    objectname -
    
    uniqueid -
    
    dataattributes -
    
    maxchildren -
    
    Returns:
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException - Apr 16, 2007
  - getPathToTop
```
public java.lang.Object[][] getPathToTop(java.lang.String objectname,
                                         java.lang.String uniqueid,
                                         java.lang.String[] dataattributes,
                                         int maxchildren)
                                  throws MXException,
                                         java.rmi.RemoteException
```
    Gets Path to Top for a given node
    
    Parameters:
    
    objectname -
    
    uniqueid -
    
    dataattributes -
    
    maxchildren -
    
    Returns:
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException - Apr 16, 2007
  - getMboValueData
```
public java.lang.Object[] getMboValueData(java.lang.String[] dataattributes)
                                   throws MXException,
                                          java.rmi.RemoteException
```
    Gets data a for givens et of attributes from the current mbo
    
    Parameters:
    
    dataattributes -
    
    Returns:
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException - Apr 16, 2007
  - setHierarchy
```
public void setHierarchy(java.lang.String objectname,
                         java.lang.String uniqueid,
                         java.lang.String hierarchy)
                  throws MXException,
                         java.rmi.RemoteException
```
    Sets the reference point for starting of the hierarchy
    
    Parameters:
    
    objectname -
    
    uniqueid -
    
    hierarchy -
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException - Apr 16, 2007
  - getobjectname
```
public java.lang.String getobjectname()
```
    Returns Object name
    
    Returns:
    
    String Apr 16, 2007
  - setobjectname
```
public void setobjectname(java.lang.String newobjectname)
```
    Sets objectname
    
    Parameters:
    
    newobjectname - Apr 16, 2007
  - getuniqueidname
```
public java.lang.String getuniqueidname()
```
    Returns uniqueidname
    
    Returns:
    
    String Apr 16, 2007
  - setuniqueidname
```
public void setuniqueidname(java.lang.String newuniqueidname)
```
    Sets uniqueidname
    
    Parameters:
    
    newuniqueidname - Apr 16, 2007
  - getuniqueidvalue
```
public java.lang.String getuniqueidvalue()
```
    Returns uniqueidvalue
    
    Returns:
    
    Apr 16, 2007
  - setuniqueidvalue
```
public void setuniqueidvalue(java.lang.String newuniqueidvalue)
```
    Sets uniqueidvalue
    
    Parameters:
    
    newuniqueidvalue - Apr 16, 2007
  - setRefreshTree
```
public void setRefreshTree(boolean flag)
```
    Sets flag for tree refresh
    
    Parameters:
    
    flag - Apr 16, 2007
  - getRefreshTree
```
public boolean getRefreshTree()
```
  - storeProperties
```
protected void storeProperties()
```
    Called from DrillDownBean to store information for the hierarchy. This is a fail safe method
  - getSourceAttributeValue
```
public java.lang.String getSourceAttributeValue()
```
    Returns:
    
    Source Attribute proeprty as String Apr 10, 2007
  - setSourceAttributeValue
```
public void setSourceAttributeValue(java.lang.String sourceAttributevalue)
```
    Sets new source attribute
    
    Parameters:
    
    sourceAttributevalue - Apr 10, 2007
  - getSourceDataAttribute
```
public java.lang.String getSourceDataAttribute()
```
    Returns:
    
    Source Data Attribute proeprty as String Apr 10, 2007
  - setSourceDataAttribute
```
public void setSourceDataAttribute(java.lang.String sourceDataattribute)
```
    Sets new source data attribute
    
    Parameters:
    
    sourceAttributevalue - Apr 10, 2007
  - getBreadcrumbs
```
public java.util.ArrayList getBreadcrumbs()
```
    Skeleon method which can be implemented to return an array list of breadcrumbs expected by the Breadcrums control. This will only eb called when the id of the bean is linked to "breadcrumsourceid" proeprty of the breadcrumbs control
    It should prepare the breadcrums as an ArrayList collection where each element is a Hashtable having following keys
    - uniqueid
    - label
    - selected - true | false
    Returns:
    
    ArrayList Apr 10, 2007
  - clearbreadcrumbs
```
public int clearbreadcrumbs()
```
  - getBoundTree
```
public Tree getBoundTree()
```
    Returns the tree control bound to this bean
    
    Returns:
    
    Tree control instance
  - markTreesForRefresh
```
public void markTreesForRefresh(java.lang.String dontRefreshMe)
```
    Marks all trees on current page to be refreshed except this one when next render come around to this one. This is done to by pass structure changed event
  - setIgnoreTreeRefresh
```
public void setIgnoreTreeRefresh(boolean ignoreTreeRefresh)
```
    Flag to avoid calling markTreesForRefresh
    
    Parameters:
    
    ignoreTreeRefresh -
  - dataChangedEvent
```
public void dataChangedEvent(DataBean speaker)
```
    Overriden
    
    Specified by:
    
    dataChangedEvent in interface DataBeanListener
    
    Overrides:
    
    dataChangedEvent in class DataBean

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

objectname

uniqueidname

uniqueidvalue

refreshTree

ignoreTreeRefresh

TreeControlBean

initialize

selectrecord

selectnode

setcurrentnode

getTop

getChildren

getPathToTop

getMboValueData

setHierarchy

getobjectname

setobjectname

getuniqueidname

setuniqueidname

getuniqueidvalue

setuniqueidvalue

setRefreshTree

getRefreshTree

storeProperties

getSourceAttributeValue

setSourceAttributeValue

getSourceDataAttribute

setSourceDataAttribute

getBreadcrumbs

clearbreadcrumbs

getBoundTree

markTreesForRefresh

setIgnoreTreeRefresh

dataChangedEvent