AppBean (Maximo API)

java.lang.Object
- psdi.webclient.system.beans.WebClientBean
- - psdi.webclient.system.beans.DataBean
  - - psdi.webclient.system.beans.AppBean

All Implemented Interfaces:

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

Direct Known Subclasses:

ActionAppBean, ActualCIAppBean, AddCrewWorkGroupBean, AMCrewAppBean, AMCrewTypeAppBean, ApptBookAppBean, ApptBookMgrAppBean, AssetAppBean, AssetCatAppBean, AttributesBean, AutoScriptAppBean, BBoardAppBean, BIMProjectBean, ChangePswdBean, ChrtAcctsAppBean, CIAppBean, CiTypeAppBean, CommTmpltAppBean, CondcodeAppBean, CondExpMgrAppBean, ConfigurBean, ContentCatalogAppBean, CraftAppBean, CreateScriptDialogBean, CronTaskAppBean, DBInfoBean, DeletePersonDataAppBean, DeploymentGroupsAppBean, DesignerAppBean, DesignSpecAppBean, DesktopReqAppBean, DlgUploadFileBean, DMAppBean, DMCollectionAppBean, DomainBean, DpamAppBean, ECommAdaptAppBean, EscalationAppBean, ExchangeAppBean, ExtsystemAppBean, FailureAppBean, FincntrlAppBean, ForgotPswdAppBean, InterrorAppBean, IntGeneratorAppBean, IntMsgTrkAppBean, IntObjectAppBean, IntsrvAppBean, InventoryAppBean, InvissueAppBean, InvokeAppBean, ItemAppBean, JSONMapAppBean, JSONResourceAppBean, KPIAppBean, KPITemplateAppBean, LabTransAppBean, LictrackAppBean, LocationAppBean, LoggingAppBean, LSNRAppBean, MapManagerBean, MaxInteractionAppBean, MeterGroupAppBean, MfMailCfgAppBean, ModelAppBean, MultiSiteAppBean, NotSiteFilterAppBean, OslcProviderAppBean, PersonGroupAppBean, PlusCAppBean, PlusCDSAppBean, PMAppBean, PortletAppBean, ProductAppBean, PropertyMaintenanceBean, PublishAppBean, ReceiptsAppBean, ReconLinkBean, ReconTaskBean, RefAppAppBean, ReportAppBean, ReportOutputAppBean, ResourceTypesDialogBean, RLAdminAppBean, RoleAppBean, SearchBean, SecurGroupBean, SelfRegAppBean, ServiceAddressBean, ServReqsAppBean, SfwlicviewBean, ShipRecAppBean, SKDAlternateAvailAppBean, SKDProjectAppBean, SKDProjectDMAppBean, SKDTooltipMgrAppBean, SLAAppBean, SoftwareCatalogAppBean, SrvItemAppBean, StartCenterAppBean, StatefulAppBean, StoreroomAppBean, TenantRegAppBean, TermCondAppBean, TokenLicAppBean, ToolInvAppBean, UserBean, WeatherCfgAppBean, WeatherOrganizationAppBean, WFAdminBean, WFDesignAppBean, WorkmanAppBean, WorkviewAppBean, WorkZoneAppBean, WSRegistryAppBean
```
public class AppBean
extends DataBean
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected BookmarkBean`	`bookmarkBean`
`static java.lang.String`	`DIRECTPRINT_LINK`
`static java.lang.String`	`DIRECTPRINT_WATTACH_LINK`
`protected static Category`	`LOG_CATEGORY`
`static int`	`LONG_OP_INPRG` Long operation in progress
`static int`	`LONG_OP_READY` Long operation has been initialized
`protected boolean`	`noResultSet`
`protected QbeBean`	`qbeBean`
`static int`	`QUERY_ALL`
`static int`	`QUERY_ALL_BOOKMARKS`
`static int`	`QUERY_KEY`
`static int`	`QUERY_NONE`
`static java.lang.String`	`QUICK_LINK`
`protected MboSetRemote`	`quickFindRemote`
`protected ResultsBean`	`resultsBean`

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, 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

AppBean()

Constructors
Constructor and Description
`AppBean()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`addrow()`
`int`	`appinfo()`
`void`	`autoInitiateWorkflow()` Start workflow automatically when a new MBO is saved.
`int`	`BOOKMARK()`
`boolean`	`canExit()` Called when leaving the application
`boolean`	`canSaveBasedOnLocks()`
`int`	`CLEAR()`
`int`	`clearfilter()`
`void`	`convertPortalParameters(WebClientSession wcs)` Convert the Parameters Passed into this app from another external application to values Maximo can understand.
`int`	`DELETE()`
`int`	`DUPLICATE()`
`void`	`ensureRecord()` This is used to load the first record in the appbean if the appbean doesn't have a table associated with it and it doesn't have a resultsbean associated with it.
`int`	`find()`
`void`	`fireStructureChangedEvent(DataBean speaker)` tells all listeners that this DataBean refrerences a new mbo or mboSetRemote
`int`	`FLTRLASET()`
`com.ibm.json.java.JSONObject`	`getAppInfo()`
`protected BookmarkBean`	`getBookmarkBean()`
`java.lang.String`	`getCurrentQueryDescription()`
`java.lang.String`	`getCurrentQueryName()`
`int`	`getCurrentRow()` Returns the current row.
`long`	`getKPIId()` Returns the unique id of the KPI that has just been created
`java.lang.String`	`getKPISelect()` Returns the default select clause to be used in CREATE KPI.
`java.lang.String`	`getKPIWhere()` Returns the User and QBE where clause on the basis of which current application is showing data.
`MboSetRemote`	`getMboSet()` Return's whether or not the MboSetRemote is null.
`java.lang.String`	`getPortalEvent(DataBean speaker)`
`int`	`getQueryOption()` Return the query option
`MboSetRemote`	`getQuickFindRemote()`
`com.ibm.json.java.JSONObject`	`getRecordLockProperties()`
`ResultsBean`	`getResultsBean()`
`protected void`	`gotoTab(SessionContext clientSession, java.lang.String tab)` Deprecated. FIREFOX - use gotoTab(WebClientSession, String) instead
`protected void`	`gotoTab(WebClientSession wcs, java.lang.String tab)`
`boolean`	`hasModifications()` Checks all the beans in the app to see if they need to be saved.
`boolean`	`hasSaveAccess()`
`boolean`	`hasSigOptionAccess(int row, java.lang.String sigOption)` Returns true if the user has record level privileges for a given sigoption on the given mbo.
`boolean`	`hasSigOptionAccess(int row, java.lang.String sigOption, boolean checkAppLevel)` Returns true if the user has record level privileges for a given sigoption on the given mbo.
`boolean`	`hasStartRecord(long uniqueId)`
`int`	`HELPWF()` Special action to show workflow help
`int`	`inboxwf()` action to perform when brung up a record from the inbox
`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
`void`	`initializeApp()` This method is called when the presentations "main" page is initalized and before the page is rendered.
`MboSetRemote`	`initQuickFIndRemote()` Added to provide a way for users to control quickfind mbo which is not needed in some cases.
`void`	`insert()` Inserts a row at the begining of the MboSet.
`int`	`INSERT()`
`boolean`	`isEmpty()` Returns try if mboset has no members
`boolean`	`isUserWhereClauseThroughIntegration()`
`int`	`launchwf()` Special action to launch a Workflow process directly
`int`	`MODIFYSLAS()` Handles the "Apply SLA" action in ticket, wo etc apps.
`int`	`moveToUniqueId(long uniqueId)` Moves to the record with the passed in uniqueid .
`int`	`NAVHISTORY()` The NAVHISTORY event is used by the NAVHISTORY sigoption and toolbar menu item.
`int`	`NEXT()`
`boolean`	`notExist()`
`int`	`PREVIOUS()`
`int`	`RECORDLOCK()`
`int`	`RECUNLOCK()`
`void`	`refreshFieldErrors()`
`void`	`reset()` Resets the MboSet.
`int`	`RESULTS()`
`int`	`returnnovalue()`
`int`	`returntoapp()`
`int`	`returnwithvalue()`
`int`	`ROUTEWF()`
`int`	`RUNAREPORT()`
`int`	`RUNREPORTBYNAME()`
`int`	`RUNREPORTS()`
`void`	`save()` Needs it's own version of save to insure the proper record is set.
`int`	`SAVE()`
`void`	`saveattachment()` Used by adding attachment.
`boolean`	`saveYesNoCheck()` Checks the AppBean to see if it needs to be saved.
`boolean`	`saveYesNoInteractionCheck()` Checks the AppBean to see if it needs to be saved.
`int`	`SEARCHATTR()`
`int`	`SEARCHMORE()`
`int`	`SEARCHWHER()`
`protected void`	`setCurrentQueryName(java.lang.String queryName)`
`void`	`setDefaultQbe(java.lang.String attribute, java.lang.String expression)`
`void`	`setFilterCleared()`
`void`	`setKPIId(long newId)` Sets the unique id of the KPI that has just been created.
`void`	`setQueryOption(int option)` Set the query option
`void`	`setupBean(SessionContext sc)` Deprecated. FIREFOX
`void`	`setupBean(WebClientSession wcs)` This method must be call after the bean is instantiated.
`void`	`setUserWhereClauseThroughIntegration(boolean userWhereClauseThroughIntegration)`
`int`	`STOPWF()` Response to the Workflow Stop action.
`int`	`STRECLOCK()`
`void`	`structureChangedEvent(DataBean speaker)` Event called by the "resultsBean" DataBean which tells this DataBean that it references a new mbo or MboSetRemote.
`int`	`submitPrintJob()` Call the external JSP/Applet to print the report.
`boolean`	`toBeSaved()` Returns whether the MboSet or it's children need to be saved.
`int`	`toggledeleterow()`
`void`	`updateForRecordLock(ControlInstance control)`

Methods inherited from class psdi.webclient.system.beans.DataBean
_useAllBookmarksQuery, _useAllRecsQuery, _usequery, addAttribute, addConditionalProperties, addDialogReference, addListener, addQbeAttribute, 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, clearQbeAttributes, clearSavedFilterSettings, clearSavedQbeSettings, close, copytonewrow, count, dataChangedEvent, delete, delete, deleteAndRemove, deleteAndRemove, displaycount, duplicateMbo, execute, fetchRecordData, fetchTableData, fetchTableData, filterrows, findAndCallMethod, fireChildChangedEvent, fireDataChangedEvent, fireDataChangedEvent, fireStructureChangedEvent, getAppWhere, getAttributes, getBoolean, getBoolean, getCacheRowIndex, getColumnDate, getColumnString, getCompleteWhere, getConditionalProperties, 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, 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, hierarchicalmove, highlightrow, highlightrow, insert, insertAtEnd, instantdelete, invalidateTableData, isAppTableRetain, isAttribute, isAttributeHidden, isAttributeHidden, isColumnSorted, 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, positionState, preSaveChecks, previous, prevrow, propagateRequired, queryAllBookmarks, queryAllRecs, refreshTable, registerDynamicControlsWithERM, reloadTable, removeDialogReference, removeListener, removeRowOnCancel, rePosition, reserveOnePair, resetDataBean, resetJSPFlags, resetQbe, resetWithSelection, restoreSavedQbeSettings, retainPosition, returnLookupValue, returnLookupValue, returnLookupValue, returnLookupValue, save, saveCurrentQbeSettings, scrollnext, scrollprev, select, select, selectAll, selectrecord, selectRows, sendRefreshTable, setApp, setApp, setAppDefault, setAppDefaults, setApplicationError, setAppWhere, setAsyncLock, setAttributes, setCurrentQueryDescription, setCurrentRecordData, setCurrentRow, setDate, setDate, setDate, setDefaultOrderBy, 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, setupNonPersistent, setUserDefaults, setUserWhere, setvalue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromComponent, smartFill, smartFill, sort, sort, sortcolumn, sortcolumn, sqlwhere, 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
  - QUERY_NONE
```
public static final int QUERY_NONE
```
    See Also:
    
    Constant Field Values
  - QUERY_ALL
```
public static final int QUERY_ALL
```
    See Also:
    
    Constant Field Values
  - QUERY_KEY
```
public static final int QUERY_KEY
```
    See Also:
    
    Constant Field Values
  - QUERY_ALL_BOOKMARKS
```
public static final int QUERY_ALL_BOOKMARKS
```
    See Also:
    
    Constant Field Values
  - LOG_CATEGORY
```
protected static final Category LOG_CATEGORY
```
  - resultsBean
```
protected ResultsBean resultsBean
```
  - qbeBean
```
protected QbeBean qbeBean
```
  - bookmarkBean
```
protected BookmarkBean bookmarkBean
```
  - noResultSet
```
protected boolean noResultSet
```
  - quickFindRemote
```
protected MboSetRemote quickFindRemote
```
  - QUICK_LINK
```
public static final java.lang.String QUICK_LINK
```
    See Also:
    
    Constant Field Values
  - DIRECTPRINT_LINK
```
public static final java.lang.String DIRECTPRINT_LINK
```
    See Also:
    
    Constant Field Values
  - DIRECTPRINT_WATTACH_LINK
```
public static final java.lang.String DIRECTPRINT_WATTACH_LINK
```
    See Also:
    
    Constant Field Values
  - LONG_OP_READY
```
public static final int LONG_OP_READY
```
    Long operation has been initialized
    
    See Also:
    
    Constant Field Values
  - LONG_OP_INPRG
```
public static final int LONG_OP_INPRG
```
    Long operation in progress
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AppBean
```
public AppBean()
```
- Method Detail
  - getQueryOption
```
public int getQueryOption()
```
    Return the query option
  - setQueryOption
```
public void setQueryOption(int option)
```
    Set the query option
  - 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
    
    TO REPLACE: use AppBean.setupBean(WebClientSession)
    
    Overrides:
    
    setupBean in class DataBean
  - hasStartRecord
```
public boolean hasStartRecord(long uniqueId)
                       throws MXException,
                              java.rmi.RemoteException
```
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - initializeApp
```
public void initializeApp()
                   throws MXException,
                          java.rmi.RemoteException
```
    This method is called when the presentations "main" page is initalized and before the page is rendered. It can be called multiple times to "reinitialize" the applicaiton, for example when the existing query is reset.
    Only on the first initialize the method also checks for these mutually exclusiive special conditions:
  - if there is a particular record the app needs to jump to (using uniqueid from the loadapp or gotoapp event) the result set is restricted to that record only
  - if there is a startup query sent through the launch in context as a startup where clause it is set as a user where clause
  - if there is an additional ecent "insert" a new record is inserted
    A subsequent call to initializeApp() will not check for these conditions, causing the default reset to happen

Throws:: MXException; java.rmi.RemoteException

initialize
```
protected void initialize()
                   throws MXException,
                          java.rmi.RemoteException
```
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

Overrides:

initialize in class DataBean

Throws:

MXException

java.rmi.RemoteException

structureChangedEvent
```
public void structureChangedEvent(DataBean speaker)
```
Event called by the "resultsBean" DataBean which tells this DataBean that it references a new mbo or MboSetRemote. The fireStructureChangedEvent is called thus setting the resetRemote flag for all the "children" MXWebClientDataBeans

Specified by:

structureChangedEvent in interface DataBeanListener

Overrides:

structureChangedEvent in class DataBean

fireStructureChangedEvent
```
public void fireStructureChangedEvent(DataBean speaker)
```
Description copied from class: DataBean

tells all listeners that this DataBean refrerences a new mbo or mboSetRemote

Overrides:

fireStructureChangedEvent in class DataBean

reset
```
public void reset()
           throws MXException
```
Description copied from class: DataBean

Resets the MboSet. Clears the internal cache and fires a structure change event to all listeners.

Overrides:

reset in class DataBean

Throws:

MXException

getMboSet
```
public MboSetRemote getMboSet()
                       throws MXException,
                              java.rmi.RemoteException
```
Return's whether or not the MboSetRemote is null. Will fetch the MboSetRemote fromt the resultsBean if there is one and the resetRemote flag is true.

Overrides:

getMboSet in class DataBean

Throws:

MXException

java.rmi.RemoteException

save
```
public void save()
          throws MXException
```
Needs it's own version of save to insure the proper record is set. If the current row is a new record then before saving, it stores the key attributes and their values. Calls save then resets the qbe and to the stored values. This insures that the inserted record stays as the current record after saving.

Overrides:

save in class DataBean

Throws:

MXException

saveattachment
```
public void saveattachment()
                    throws MXException
```
Used by adding attachment. Don't start workflow when attachment is saved. Difference from save() is that it won't call autoInitiateWorkflow()

Throws:

MXException

autoInitiateWorkflow

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

Start workflow automatically when a new MBO is saved.

Throws:: java.rmi.RemoteException; MXException

convertPortalParameters
```
public void convertPortalParameters(WebClientSession wcs)
```
Convert the Parameters Passed into this app from another external application to values Maximo can understand. Override this in the application's appBean.

getPortalEvent

public java.lang.String getPortalEvent(DataBean speaker)

getCurrentRow
```
public int getCurrentRow()
```
Description copied from class: DataBean

Returns the current row.

Overrides:

getCurrentRow in class DataBean

isEmpty
```
public boolean isEmpty()
                throws MXException,
                       java.rmi.RemoteException
```
Description copied from class: DataBean

Returns try if mboset has no members

Overrides:

isEmpty in class DataBean

Throws:

MXException

java.rmi.RemoteException

notExist

public boolean notExist()
                 throws MXException,
                        java.rmi.RemoteException

Overrides:: notExist in class DataBean
Throws:: MXException; java.rmi.RemoteException

saveYesNoCheck
```
public boolean saveYesNoCheck()
                       throws MXException
```
Checks the AppBean to see if it needs to be saved. If it does then it throw an MXException ("jspmessages", "savecontinue"). If the user selects YES then the AppBean is saved, if the user selects NO the AppBean is reset (throwing away the changes). Returns false if the user select Cancel.

Returns:

true means continue, false means stop what was going to happen

Throws:

MXApplicationYesNoCancelException - Thrown with "jspmessages" and one of "savecontinue", "interactioncontinue", or "saveinteractioncontinue" if the user has unsaved changes and or is in the middle of a workflow interaction.

MXException

canSaveBasedOnLocks

public boolean canSaveBasedOnLocks()
                            throws MXException

Throws:: MXException

saveYesNoInteractionCheck
```
public boolean saveYesNoInteractionCheck()
                                  throws MXException
```
Checks the AppBean to see if it needs to be saved. If it does then it throw an MXException ("jspmessages", "savecontinue"). If the user selects YES then the AppBean is saved, if the user selects NO the AppBean is reset (throwing away the changes). Returns false if the user select Cancel or longop has started. This method will be called again when longop is complete.

Returns:

true means continue, false means stop what was going to happen

Throws:

MXApplicationYesNoCancelException - Thrown with "jspmessages" and one of "savecontinue", "interactioncontinue", or "saveinteractioncontinue" if the user has unsaved changes and or is in the middle of a workflow interaction.

MXException

toBeSaved
```
public boolean toBeSaved()
                  throws MXException
```
Description copied from class: DataBean

Returns whether the MboSet or it's children need to be saved.

Overrides:

toBeSaved in class DataBean

Throws:

MXException

getAppInfo

public com.ibm.json.java.JSONObject getAppInfo()
                                        throws MXException,
                                               java.rmi.RemoteException

Throws:: MXException; java.rmi.RemoteException

appinfo

public int appinfo()
            throws MXException

Throws:: MXException

public int NEXT()
         throws MXException

Throws:: MXException

NAVHISTORY
```
public int NAVHISTORY()
```
The NAVHISTORY event is used by the NAVHISTORY sigoption and toolbar menu item. This event will show the Navigation/View History if they've been collected via the heirarchicalmoveto event. This event ends up calling the showmenu() event passing the 'navhistory' menu name. See Menus for more information about the 'navhistory' menu.

To add the NAVHISTORY support to the application, you'll need to add the sigoption.
```
 <add_sigoption visible="false" app="ASSET"
                optionname="NAVHISTORY" description="View History" grantapp="ASSET"
                grantoption="READ" esigenabled="false" langcode="EN" />
 
```
And, to add the icon to the application toolbar, you'll need to add an entry to MAXMENU
```
 insert into maxmenu (menutype, moduleapp, position,
                        subposition,elementtype, keyvalue, headerdescription, visible,
                        image, accesskey, tabdisplay,maxmenuid)
                        Values
                        ('APPTOOL','ASSET',24,0,'OPTION','NAVHISTORY','','1','nav_icon_viewHistory.gif','','MAIN',maxmenuseq.nextval)
                        ;
 
```
All hierarchicalmoveto events will capture the moveto history and populate the menu, which can be accessed via the toolbar view history icon.
Returns:

SAVE

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

Throws:: MXException; java.rmi.RemoteException

RUNREPORTS
```
public int RUNREPORTS()
```

RUNREPORTBYNAME

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

Throws:: MXException; java.rmi.RemoteException

RUNAREPORT

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

Throws:: MXException; java.rmi.RemoteException

public int PREVIOUS()
             throws MXException

Throws:: MXException

insert
```
public void insert()
            throws MXException,
                   java.rmi.RemoteException
```
Description copied from class: DataBean

Inserts a row at the begining of the MboSet. Fires a row change event to all listeners upon success.

Overrides:

insert in class DataBean

Throws:

MXException

java.rmi.RemoteException

INSERT

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

Throws:: MXException; java.rmi.RemoteException

DELETE

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

Throws:: MXException; java.rmi.RemoteException

addrow
```
public int addrow()
           throws MXException
```
Overrides:

addrow in class DataBean

Throws:

MXException

toggledeleterow
```
public int toggledeleterow()
                    throws MXException
```
Overrides:

toggledeleterow in class DataBean

Throws:

MXException

DUPLICATE

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

Throws:: MXException; java.rmi.RemoteException

CLEAR

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

Throws:: MXException; java.rmi.RemoteException

BOOKMARK

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

Throws:: MXException; java.rmi.RemoteException

RESULTS

public int RESULTS()
            throws MXException

Throws:: MXException

gotoTab

protected void gotoTab(SessionContext clientSession,
                       java.lang.String tab)

Deprecated. FIREFOX - use gotoTab(WebClientSession, String) instead

gotoTab

protected void gotoTab(WebClientSession wcs,
                       java.lang.String tab)

find

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

Throws:: MXException; java.rmi.RemoteException

returnwithvalue

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

Throws:: MXException; java.rmi.RemoteException

returnnovalue

public int returnnovalue()
                  throws MXException

Throws:: MXException

returntoapp

public int returntoapp()
                throws MXException

Throws:: MXException

getQuickFindRemote
```
public MboSetRemote getQuickFindRemote()
```
Returns:

-- Returns the mboSetRemote used in the quickfind event. This is used to determine if the record exists before reseting the ResultBean. You would only need the get the quickFindRemote is there were special restrictions on the records available for the results list.

setDefaultQbe

public void setDefaultQbe(java.lang.String attribute,
                          java.lang.String expression)

Overrides:: setDefaultQbe in class DataBean

getResultsBean
```
public ResultsBean getResultsBean()
```

RECORDLOCK

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

Throws:: MXException; java.rmi.RemoteException

RECUNLOCK

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

Throws:: MXException; java.rmi.RemoteException

STRECLOCK

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

Throws:: MXException; java.rmi.RemoteException

getRecordLockProperties

public com.ibm.json.java.JSONObject getRecordLockProperties()

updateForRecordLock

public void updateForRecordLock(ControlInstance control)

ROUTEWF

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

Throws:: MXException; java.rmi.RemoteException

STOPWF

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

Response to the Workflow Stop action.

Throws:: MXException; java.rmi.RemoteException

launchwf

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

Special action to launch a Workflow process directly

Throws:: MXException; java.rmi.RemoteException

SEARCHMORE

public int SEARCHMORE()
               throws MXException

Throws:: MXException

SEARCHWHER

public int SEARCHWHER()
               throws MXException

Throws:: MXException

SEARCHATTR

public int SEARCHATTR()
               throws MXException

Throws:: MXException

FLTRLASET

public int FLTRLASET()
              throws MXException

Throws:: MXException

setKPIId
```
public void setKPIId(long newId)
```
Sets the unique id of the KPI that has just been created. This method will be called from the Create KPI Dialog

Parameters:

newId - new KPI Unique Id as long

getKPIId
```
public long getKPIId()
```
Returns the unique id of the KPI that has just been created

Returns:

KPI Unique Id as long

getKPIWhere
```
public java.lang.String getKPIWhere()
                             throws MXException,
                                    java.rmi.RemoteException
```
Returns the User and QBE where clause on the basis of which current application is showing data. This method should be overridden in case an application needs to set its own specific WHERE clause. (e.g applications not having List tab)

Returns:

complete where clause as a String

Throws:

MXException

java.rmi.RemoteException

getKPISelect
```
public java.lang.String getKPISelect()
                              throws MXException,
                                     java.rmi.RemoteException
```
Returns the default select clause to be used in CREATE KPI. This method can be overridden in case some application decides to provide a special select clause to the CREATE KPI action.

Returns:

default select clause as String

Throws:

MXException

java.rmi.RemoteException

MODIFYSLAS

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

Handles the "Apply SLA" action in ticket, wo etc apps.

Throws:: MXException; java.rmi.RemoteException

moveToUniqueId

public int moveToUniqueId(long uniqueId)
                   throws MXException,
                          java.rmi.RemoteException

Moves to the record with the passed in uniqueid .

Throws:: MXException; java.rmi.RemoteException

canExit

public boolean canExit()
                throws MXException,
                       java.rmi.RemoteException

Called when leaving the application

Throws:: MXException; java.rmi.RemoteException

getCurrentQueryName
```
public java.lang.String getCurrentQueryName()
```
Overrides:

getCurrentQueryName in class DataBean

setCurrentQueryName
```
protected void setCurrentQueryName(java.lang.String queryName)
```
Overrides:

setCurrentQueryName in class DataBean

See Also:

DataBean.setCurrentQueryName(java.lang.String)

getCurrentQueryDescription
```
public java.lang.String getCurrentQueryDescription()
```
Overrides:

getCurrentQueryDescription in class DataBean

getBookmarkBean

protected BookmarkBean getBookmarkBean()
                                throws MXException

Throws:: MXException

HELPWF

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

Special action to show workflow help

Throws:: MXException; java.rmi.RemoteException

inboxwf
```
public int inboxwf()
            throws MXException,
                   java.rmi.RemoteException
```
action to perform when brung up a record from the inbox

Throws:

MXException

java.rmi.RemoteException

ensureRecord
```
public void ensureRecord()
                  throws java.rmi.RemoteException,
                         MXException
```
This is used to load the first record in the appbean if the appbean doesn't have a table associated with it and it doesn't have a resultsbean associated with it. This is mainly needed for single page apps that just insert a main record.

Throws:

java.rmi.RemoteException

MXException

setFilterCleared
```
public void setFilterCleared()
```

clearfilter
```
public int clearfilter()
                throws MXException
```
Overrides:

clearfilter in class DataBean

Throws:

MXException

hasSaveAccess
```
public boolean hasSaveAccess()
```

submitPrintJob
```
public int submitPrintJob()
                   throws MXException
```
Call the external JSP/Applet to print the report. Used by(PAD) option. Determine all the valide docs to be printed also.

Returns:

Throws:

MXException

java.rmi.RemoteException

isUserWhereClauseThroughIntegration

public boolean isUserWhereClauseThroughIntegration()

setUserWhereClauseThroughIntegration

public void setUserWhereClauseThroughIntegration(boolean userWhereClauseThroughIntegration)

hasSigOptionAccess
```
public boolean hasSigOptionAccess(int row,
                                  java.lang.String sigOption,
                                  boolean checkAppLevel)
                           throws java.rmi.RemoteException,
                                  MXException
```
Returns true if the user has record level privileges for a given sigoption on the given mbo. If the user is on the list tab or a single page app, the privileges will be checked on an app level. If the mbo doesn't exist, and the user is on the list tab or a single page app, the privileges will be checked on an app level.

Parameters:

row - - The index of the mbo to do the check on.

sigOption - - The sigoption that will be checked to see if the user has privileges for it, for the given Mbo.

Returns:

Throws:

java.rmi.RemoteException

MXException

hasSigOptionAccess
```
public boolean hasSigOptionAccess(int row,
                                  java.lang.String sigOption)
                           throws java.rmi.RemoteException,
                                  MXException
```
Returns true if the user has record level privileges for a given sigoption on the given mbo. If the user is on the list tab or a single page app, the privileges will be checked on an app level. If the mbo doesn't exist, and the user is on the list tab or a single page app, the privileges will be checked on an app level.

Overrides:

hasSigOptionAccess in class DataBean

Parameters:

row - - The index of the mbo to do the check on.

sigOption - - The sigoption that will be checked to see if the user has privileges for it, for the given Mbo.

Returns:

Throws:

java.rmi.RemoteException

MXException

refreshFieldErrors

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

Overrides:: refreshFieldErrors in class DataBean
Throws:: java.rmi.RemoteException; MXException

initQuickFIndRemote

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

Added to provide a way for users to control quickfind mbo which is not needed in some cases.

Returns:
Throws:: java.rmi.RemoteException; MXException

hasModifications
```
public boolean hasModifications()
```
Checks all the beans in the app to see if they need to be saved.

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

QUERY_NONE

QUERY_ALL

QUERY_KEY

QUERY_ALL_BOOKMARKS

LOG_CATEGORY

resultsBean

qbeBean

bookmarkBean

noResultSet

quickFindRemote

QUICK_LINK

DIRECTPRINT_LINK

DIRECTPRINT_WATTACH_LINK

LONG_OP_READY

LONG_OP_INPRG

AppBean

getQueryOption

setQueryOption

setupBean

setupBean

hasStartRecord

initializeApp