Maximo 7.6 API - BoundComponentInstance

java.lang.Object
- psdi.webclient.system.controller.BaseInstance
- - psdi.webclient.system.controller.ComponentInstance
  - - psdi.webclient.system.controller.DynamicAttributeComponent
    - - psdi.webclient.system.controller.BoundComponentInstance

All Implemented Interfaces:

java.lang.Cloneable, DataBeanListener

Direct Known Subclasses:

Checkbox, ComboboxText, DefaultValue, GLNavigator, GpsDataCollectorComponent, Image, Label, MapComponent, MapDispatcherComponent, MisbehavingComponent, QuickSearchTextBox, RecordImage, RequiredIndicator, RichTextEditor, RichTextViewer, RouteComponent, SimpleChartComponent, SortImage, TextArea, Textbox, ToggleImage, ToolbarComboboxText, UnboundComponentInstance
```
public class BoundComponentInstance
extends DynamicAttributeComponent
```

Property Summary
- Properties inherited from class psdi.webclient.system.controller.ComponentInstance
  hiddenByProperty

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTRIBUTE_NAME`
`static java.lang.String`	`BAD_BINDING_CSS`
`boolean`	`bound`
`static java.lang.String`	`BOUND_LABEL`
`static java.lang.String`	`COLUMN_NAME`
`static java.lang.String`	`CSS_CLASS`
`static java.lang.String`	`DATA_ATTRIBUTE`
`static java.lang.String`	`DEFAULT_LABEL`
`static java.lang.String`	`DOMAIN`
`static java.lang.String`	`ENTITY_NAME`
`static java.lang.String`	`EVENT_PRIORITY`
`static java.lang.String`	`FIELD_LABEL`
`static java.lang.String`	`HAS_LONG_DESCRIPTION`
`static java.lang.String`	`HIDE_LABEL`
`static java.lang.String`	`ID`
`static java.lang.String`	`INT_TYPE`
`static java.lang.String`	`INTERNAL`
`static java.lang.String`	`INVALID_BINDING`
`static java.lang.String`	`IS_NUMERIC`
`static java.lang.String`	`IS_PERSISTENT`
`static java.lang.String`	`KEY`
`static java.lang.String`	`LABEL`
`static java.lang.String`	`LABELFORMAT`
`static java.lang.String`	`LENGTH`
`static java.lang.String`	`LONGDESC_ATTRIBUTE_SUFFIX`
`static java.lang.String`	`OBJECT_NAME`
`static int`	`PRIORITY_DATATYPE`
`static int`	`PRIORITY_FLUSH`
`static int`	`PRIORITY_VALIDATION`
`static java.lang.String`	`QUERY`
`static java.lang.String`	`REMARKS`
`static java.lang.String`	`SCALE`
`static java.lang.String`	`SIZE`
`static java.lang.String`	`SYNCHRONOUS`
`static java.lang.String`	`TAKESVALUE`
`static java.lang.String`	`TITLE`
`static java.lang.String`	`TRUELENGTH`
`static java.lang.String`	`TYPEAHEADATTRS`

Fields inherited from class psdi.webclient.system.controller.DynamicAttributeComponent
CLASSSPECVALUEATTRIBUTES, DYNAMICATTRIBUTE

Fields inherited from class psdi.webclient.system.controller.ComponentInstance
CLICKABLE_OFF, CLICKABLE_ON, CONTAINER_ERROR, CONTAINER_ERROR_IMAGE, CONTAINER_WARNING, CONTAINER_WARNING_IMAGE, LOG_CATEGORY, NOT_CLICKABLE, popDefinition

Fields inherited from class psdi.webclient.system.controller.BaseInstance
EXCEPTION_ERROR, EXCEPTION_INFO, EXCEPTION_NONE, EXCEPTION_REQUIREDFIELD, EXCEPTION_SMARTFILL, EXCEPTION_WARNING, EXCEPTION_YESNOCANCEL, FORCE_WARNING_HANDLING, NO_PROMPT_WITH_WARNING, presentationTags, PROMPT_WHEN_WARNING_EXIST

Constructor Summary

Constructors
Constructor and Description

BoundComponentInstance()

Constructors
Constructor and Description
`BoundComponentInstance()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAttributeError(ERMAttributeError attributeError)` Adds the ERMAttributeError to the BoundComponents error list if the BoundCOmponent does not have another error.
`void`	`addSetValueError(SetValueError error)` Adds the SetValueError to the components error list and also bubbles the error up thru the parent container controls.
`int`	`applink()` Handler for the applink event.
`void`	`cleanup()`
`void`	`clearErrors()` Removes all SetValueErrors associated with this BoundComponent
`void`	`createChangedPropList()` Needed to override this method because restoring the title property to is default value needed to be handled specially
`boolean`	`dataRestrictionCheck()` Returns true if there is a field level data restriction on the attribute preventing the control from being visible.
`int`	`datelookup()` Prepares a collection of information before datepopup is called.
`int`	`decrement()` Called from front end when the field data type is DATE, TIME of DATETIME This even can only be called when user presses DOWN_ARROW keys on date fields.
`int`	`exceptionhandled()`
`java.lang.String`	`getApplink()`
`boolean`	`getBoolean()` Returns the component's value as a boolean.
`SetValueError`	`getCurrentError()` Returns the current SetValueError for this BoundComponent.
`DataBean`	`getDataBean()` Return the databean that is defined by the component's control's datasrc property.
`int`	`getDataType()` Return the max data type of the attribute the component is bound to.
`java.lang.String`	`getDataValueInError()` Used to get the invalid value entered into component
`SetValueError`	`getErrorForRow(int row)` Return the error level for the error assiciated with the passed in row.
`java.lang.String`	`getExcDialogIcon(int exceptionType)` Get tooltip dialog error icon
`int`	`getExceptionType()` Returns the exception type if any attached to this component.
`com.ibm.json.java.JSONObject`	`getFieldInfo()` Returns data type information about this attribute to be added as an attribute on a field
`int`	`getHighestErrorLevel()` validates all errors associated with the boundcomponent (there can be multiple if the component is within a table) and returns the highest error level.
`java.lang.String`	`getInputMode()` Returns the value of the component's inputmode property.
`java.lang.String`	`getInputModeWithoutPasswordPrefix()` Returns the inputmode without the password prefix.
`ComponentInstance`	`getLinkBack()` Used to get the original component in a linkedcomponent scenario
`java.lang.String`	`getLongDescription()` Returns the long description value of this component.
`java.lang.String`	`getLookupName()`
`java.lang.String`	`getQbeNameWithPrepend()`
`java.lang.String`	`getRenderIdForAutoFill()` Returns the renderid to be used by the autofill info.
`java.lang.String`	`getString()` Returns the component's value as a String.
`java.util.List<MXException>`	`getWarningList()` Returns the warning list
`java.lang.String`	`getWarningMessages()` Returns warning messages tied to this component if any
`boolean`	`hasChanged()` Returns true if there has been a change to the component's data, readonly, or required states.
`boolean`	`hasDataChanged()` Returns the value of the datachanged flag that was set by the a call to hasChanged().
`boolean`	`hasLongDescChanged()` Returns the value of the longDescChanged flag that was set by the a call to hasChanged().
`boolean`	`hasLongDescription()` Returns true if the component actually has a non-empty long description value.
`boolean`	`hasReadonlyChanged()` Returns the value of the readonlychanged flag that was set by the a call to hasChanged().
`boolean`	`hasRequiredChanged()` Returns the value of the requiredchanged flag that was set by the a call to hasChanged().
`boolean`	`hasWarnings()` Check if warning exists
`int`	`increment()` Called from front end when the field data type is DATE, TIME of DATETIME This even can only be called when user presses UP_ARROW keys on date fields.
`void`	`initialize()` Called when the app broadcasts an "initialize" event to all components.
`void`	`instantiatedatasrc()` A broadcast event method that binds the component to the component's databean.
`boolean`	`isDataValid()`
`boolean`	`isDefault()` Returns whether the component is a default field or not.
`boolean`	`isMasked()` Check the inputmode property along with the BoundComponents MboValueData to see if the component is masked.
`boolean`	`isOnCurrentRow()`
`boolean`	`isPasswordField()` Check if the field is password field Return true if this is a password field
`boolean`	`isQuery()` Returns whether the component is a query field or not.
`boolean`	`isReadOnly()` Returns true if this component (or linked component) is defined as readonly in the mbo, or if the inputmode is readonly in the presentation xml.
`boolean`	`isRequired()` Returns true if this component is defined as required in the mbo, or if the inputmode is required in the presentation xml.
`boolean`	`isRevert()` Check if Revert button is clicked
`boolean`	`isRowDeleted()`
`boolean`	`isSmartFillEnabled(MboValueData mvd)` Returns true if the BoundComponentInstance is smartfill enabled.
`int`	`popexception()` This event is called when use hovers the mouse over the error or warning icon.
`int`	`processAsyncYesNoCancel()` Handle the async error tool tip dialog yes/no/cancel button click event
`int`	`processEdit()` Handle the async error tool tip dialog "Edit My Value" button click event
`int`	`processIgnoreWarning()` Handle the async error tool tip dialog "Use My Value" button click event
`int`	`processProfile(java.lang.String profileName)`
`int`	`processRevert()` Handle the async error tool tip dialog "Go Back" button click event
`void`	`readOnlyCheck()` Throws an MXApplicationException("jspmessages", "fieldreadonly") if the component (or the linked component) is read only.
`void`	`removeCurrentError()`
`int`	`render()` Needed to override this method to cache original values for data, readonly, required and applink
`void`	`resetIsRevert()` Reset the revertvalue
`boolean`	`retryErrorValues()` This method will loop thru all the errors set on the BoundComponent and try setting the errored values again.
`int`	`selectvalue()` Handler for the selectvalue event
`void`	`setBoundAsRequired()` Deprecated. This method is no longer needed as the boundAsRequired is not longer needed. Instead call madeRequiredConditionally on the DataBean the component is bound to.
`int`	`setcurrentdate()` Called from front end when the field data type is DATE, TIME of DATETIME This even can only be called when user presses SHIFT + 7 (for &) or SHIFT + UP ARROW
`void`	`setDataValid(boolean isDataValid)` For interaction with DataBean.setvalue()
`void`	`setDataValueInError(java.lang.String s)` Used to set/store an invalid value entered into component
`void`	`updateCachedDataValue(java.lang.String value)`
`boolean`	`useMaxLength()` used to determine whether we can limit the number of entered characters in a field if there is a domain and it has more than the key used in the typeahead we cannot limit so that typeahead searching will work

Methods inherited from class psdi.webclient.system.controller.DynamicAttributeComponent
click, dataChangedEvent, getProperty, hasAnyPropertyChanged, needsRender, resetAttribute, structureChangedEvent

Methods inherited from class psdi.webclient.system.controller.ComponentInstance
action, broadcastEvent, canChangeRowFocus, clearChangedFlag, clearUIUpdates, controlPropertyChanged, fetchtooltip, findComponentByDescriptorId, findProperty, formatLabel, formatLabel, getChildrenDesignOnly, getClickState, getComponentContainerId, getControl, getCssClass, getCurrent, getCurrentUpdates, getDesignerSelected, getErrorInfo, getFocusRenderId, getId, getId, getIdWithoutRow, getLabelForRenderId, getLabelledByRenderId, getLinkedComponentInstance, getMenuType, getOriginalProperty, getRenderId, getUpdatedAttributes, getUpdatedStyles, hasChildren, hasComponents, hasLocalProperty, hasMaskedChanged, hasUnappliedUIUpdates, hiddenByProp, hiddenByProperty, isAsyncEnabled, isChild, isComponent, isDefaultRender, isDisabled, isHoversActive, isIncluded, isOnTableFilterRow, isOnTableRow, isOnTableTitleRow, isVisible, query, renderChildComponents, renderChildrenControls, rerendering, setChangedFlag, setChangedFlag, setComponentContainerId, setControl, setFocus, setIsHoversActive, setLabelFormat, showMenu, showMenubarMenu, signout, skipRender, updateAttribute, updateStyle, updateStyle

Methods inherited from class psdi.webclient.system.controller.BaseInstance
addChild, addChild, addRefreshListener, clearChildren, clearProperties, clone, clone, getBoolean, getChildCount, getChildIndex, getChildren, getConsiderInDesigner, getDescriptor, getIdExtension, getInt, getLocalizedType, getPage, getParent, getParentInstance, getPropertyNames, getRefreshListeners, getRowNum, getSafeId, getString, getType, getWebClientSession, handleEvent, handleEvent, hasPropertyChanged, initProperty, isDynamicContainer, isOnTable, maintainControlId, removeProperty, setConsiderInDesigner, setDescriptor, setDynamicContainer, setOnTable, setParent, setProperty, setProperty, setRenderId, setType, setWebClientSession, toString

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

- Field Detail
  - ID
```
public static final java.lang.String ID
```
    See Also:
    Constant Field Values
  - CSS_CLASS
```
public static final java.lang.String CSS_CLASS
```
    See Also:
    Constant Field Values
  - DATA_ATTRIBUTE
```
public static final java.lang.String DATA_ATTRIBUTE
```
    See Also:
    Constant Field Values
  - DOMAIN
```
public static final java.lang.String DOMAIN
```
    See Also:
    Constant Field Values
  - KEY
```
public static final java.lang.String KEY
```
    See Also:
    Constant Field Values
  - TYPEAHEADATTRS
```
public static final java.lang.String TYPEAHEADATTRS
```
    See Also:
    Constant Field Values
  - REMARKS
```
public static final java.lang.String REMARKS
```
    See Also:
    Constant Field Values
  - TITLE
```
public static final java.lang.String TITLE
```
    See Also:
    Constant Field Values
  - QUERY
```
public static final java.lang.String QUERY
```
    See Also:
    Constant Field Values
  - LENGTH
```
public static final java.lang.String LENGTH
```
    See Also:
    Constant Field Values
  - TRUELENGTH
```
public static final java.lang.String TRUELENGTH
```
    See Also:
    Constant Field Values
  - SCALE
```
public static final java.lang.String SCALE
```
    See Also:
    Constant Field Values
  - IS_NUMERIC
```
public static final java.lang.String IS_NUMERIC
```
    See Also:
    Constant Field Values
  - HAS_LONG_DESCRIPTION
```
public static final java.lang.String HAS_LONG_DESCRIPTION
```
    See Also:
    Constant Field Values
  - INT_TYPE
```
public static final java.lang.String INT_TYPE
```
    See Also:
    Constant Field Values
  - IS_PERSISTENT
```
public static final java.lang.String IS_PERSISTENT
```
    See Also:
    Constant Field Values
  - ENTITY_NAME
```
public static final java.lang.String ENTITY_NAME
```
    See Also:
    Constant Field Values
  - OBJECT_NAME
```
public static final java.lang.String OBJECT_NAME
```
    See Also:
    Constant Field Values
  - ATTRIBUTE_NAME
```
public static final java.lang.String ATTRIBUTE_NAME
```
    See Also:
    Constant Field Values
  - COLUMN_NAME
```
public static final java.lang.String COLUMN_NAME
```
    See Also:
    Constant Field Values
  - BOUND_LABEL
```
public static final java.lang.String BOUND_LABEL
```
    See Also:
    Constant Field Values
  - FIELD_LABEL
```
public static final java.lang.String FIELD_LABEL
```
    See Also:
    Constant Field Values
  - HIDE_LABEL
```
public static final java.lang.String HIDE_LABEL
```
    See Also:
    Constant Field Values
  - INTERNAL
```
public static final java.lang.String INTERNAL
```
    See Also:
    Constant Field Values
  - LABEL
```
public static final java.lang.String LABEL
```
    See Also:
    Constant Field Values
  - DEFAULT_LABEL
```
public static final java.lang.String DEFAULT_LABEL
```
    See Also:
    Constant Field Values
  - SIZE
```
public static final java.lang.String SIZE
```
    See Also:
    Constant Field Values
  - LABELFORMAT
```
public static final java.lang.String LABELFORMAT
```
    See Also:
    Constant Field Values
  - INVALID_BINDING
```
public static final java.lang.String INVALID_BINDING
```
    See Also:
    Constant Field Values
  - BAD_BINDING_CSS
```
public static final java.lang.String BAD_BINDING_CSS
```
    See Also:
    Constant Field Values
  - LONGDESC_ATTRIBUTE_SUFFIX
```
public static final java.lang.String LONGDESC_ATTRIBUTE_SUFFIX
```
    See Also:
    Constant Field Values
  - EVENT_PRIORITY
```
public static final java.lang.String EVENT_PRIORITY
```
    See Also:
    Constant Field Values
  - TAKESVALUE
```
public static final java.lang.String TAKESVALUE
```
    See Also:
    Constant Field Values
  - SYNCHRONOUS
```
public static final java.lang.String SYNCHRONOUS
```
    See Also:
    Constant Field Values
  - PRIORITY_DATATYPE
```
public static final int PRIORITY_DATATYPE
```
    See Also:
    Constant Field Values
  - PRIORITY_VALIDATION
```
public static final int PRIORITY_VALIDATION
```
    See Also:
    Constant Field Values
  - PRIORITY_FLUSH
```
public static final int PRIORITY_FLUSH
```
    See Also:
    Constant Field Values
  - bound
```
public boolean bound
```
- Constructor Detail
  - BoundComponentInstance
```
public BoundComponentInstance()
```
- Method Detail
  - updateCachedDataValue
```
public void updateCachedDataValue(java.lang.String value)
```
  - hasChanged
```
public boolean hasChanged()
```
    Returns true if there has been a change to the component's data, readonly, or required states. To find out what specifically has changed use the hasDataChanged(), hasReadonlyChanged(), hasRequiredChanged() methods. NOTE: This method will update the cached data, readonly, and required values to the new values.
    
    Overrides:
    
    hasChanged in class DynamicAttributeComponent
    
    See Also:
    hasChanged()
  - hasDataChanged
```
public boolean hasDataChanged()
```
    Returns the value of the datachanged flag that was set by the a call to hasChanged(). Returns true if the component's data has changed. Also resets the datachanged flag to false.
  - hasLongDescChanged
```
public boolean hasLongDescChanged()
```
    Returns the value of the longDescChanged flag that was set by the a call to hasChanged(). Returns true if the component's long desc state has changed. Also resets the longDescChanged flag to false.
  - hasReadonlyChanged
```
public boolean hasReadonlyChanged()
```
    Returns the value of the readonlychanged flag that was set by the a call to hasChanged(). Returns true if the component's readonlyness has changed. Also resets the readonlychanged flag to false.
  - hasRequiredChanged
```
public boolean hasRequiredChanged()
```
    Returns the value of the requiredchanged flag that was set by the a call to hasChanged(). Returns true if the component's requiredness has changed. Also resets the requiredchanged flag to false.
  - setDataValid
```
public void setDataValid(boolean isDataValid)
```
    For interaction with DataBean.setvalue()
  - isDataValid
```
public boolean isDataValid()
```
    Returns:
    true when the data in the bound component is the same as the data on the bean`
  - getInputMode
```
public java.lang.String getInputMode()
```
    Returns the value of the component's inputmode property. If the component's inputmode is not set then the method checks to see if there is a linked component (defined by the linkedcomponent property) and returns the linked component's inputmode. The returned inputmode is converted to all lowercase.
    
    Returns:
    the value of the inputmode property or ""
  - getInputModeWithoutPasswordPrefix
```
public java.lang.String getInputModeWithoutPasswordPrefix()
```
    Returns the inputmode without the password prefix.
  - initialize
```
public void initialize()
```
    Called when the app broadcasts an "initialize" event to all components. Loads the component's properties from the mbo.
    
    Overrides:
    
    initialize in class DynamicAttributeComponent
  - getString
```
public java.lang.String getString()
```
    Returns the component's value as a String.
  - getBoolean
```
public boolean getBoolean()
```
    Returns the component's value as a boolean. If the value is null false is returned as it's assumed that a checkbox is asking for the value to know if it needs to be checked or not.
  - readOnlyCheck
```
public void readOnlyCheck()
                   throws MXException
```
    Throws an MXApplicationException("jspmessages", "fieldreadonly") if the component (or the linked component) is read only. Call isReadOnly() if you just want to know if the component is readonly without the exception.
    
    Throws:
    
    MXException - if the component is readonly
  - isReadOnly
```
public boolean isReadOnly()
```
    Returns true if this component (or linked component) is defined as readonly in the mbo, or if the inputmode is readonly in the presentation xml.
  - isRequired
```
public boolean isRequired()
```
    Returns true if this component is defined as required in the mbo, or if the inputmode is required in the presentation xml.
  - getLongDescription
```
public java.lang.String getLongDescription()
```
    Returns the long description value of this component.
  - hasLongDescription
```
public boolean hasLongDescription()
```
    Returns true if the component actually has a non-empty long description value.
    Note: this is different from the HAS_LONG_DESCRIPTION property which only indicates whether the component IS ALLOWED to have a long description.
  - applink
```
public int applink()
            throws java.rmi.RemoteException,
                   MXException
```
    Handler for the applink event. Sets an internal flag that when seen by jsp signals it to send the browser to the linked application.
    It is expected that only textbox components will be receiving this event. Only textbox.jsp checks for the flag set here
    
    Returns:
    EventQueue.PROCESS_NEXT_EVENT
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - selectvalue
```
public int selectvalue()
                throws MXException
```
    Handler for the selectvalue event
    
    Returns:
    EventQueue.PROCESS_NEXT_EVENT
    
    Throws:
    
    MXException
  - isOnCurrentRow
```
public boolean isOnCurrentRow()
```
  - isRowDeleted
```
public boolean isRowDeleted()
```
  - getQbeNameWithPrepend
```
public java.lang.String getQbeNameWithPrepend()
```
  - processProfile
```
public int processProfile(java.lang.String profileName)
```
    Returns:
    PROCESS_NEXT_EVENT,EVENT_STOP_ALL
  - getDataBean
```
public DataBean getDataBean()
```
    Description copied from class: ComponentInstance
    
    Return the databean that is defined by the component's control's datasrc property. Will return null is datasrc property is null or the datasrc/databean isn't instantiated within the component's AppInstance.
    
    Overrides:
    
    getDataBean in class ComponentInstance
  - exceptionhandled
```
public int exceptionhandled()
```
  - datelookup
```
public int datelookup()
```
    Prepares a collection of information before datepopup is called. Launches the correct datepopup by checking the datatype
    
    Returns:
    WebClientBean.EVENT_HANDLED;
  - getLookupName
```
public java.lang.String getLookupName()
```
    Overrides:
    
    getLookupName in class ComponentInstance
  - getApplink
```
public java.lang.String getApplink()
```
    Overrides:
    
    getApplink in class ComponentInstance
  - isDefault
```
public boolean isDefault()
```
    Returns whether the component is a default field or not. (Sets a default value.)
    
    Returns:
    true:default field - false: not a default field
  - isQuery
```
public boolean isQuery()
```
    Returns whether the component is a query field or not. (Sets a qbe value.)
    
    Returns:
    true:query field - false: not a query field
  - instantiatedatasrc
```
public void instantiatedatasrc()
```
    A broadcast event method that binds the component to the component's databean.
  - getDataType
```
public int getDataType()
```
    Return the max data type of the attribute the component is bound to. Compare values to MXFormat data type constants.
  - cleanup
```
public void cleanup()
```
    Overrides:
    
    cleanup in class DynamicAttributeComponent
  - isMasked
```
public boolean isMasked()
```
    Check the inputmode property along with the BoundComponents MboValueData to see if the component is masked.
    
    Overrides:
    
    isMasked in class ComponentInstance
    
    Returns:
    Returns true if the component's data is masked, false it is not.
    See Also:
    ComponentInstance.isMasked()
  - createChangedPropList
```
public void createChangedPropList()
```
    Needed to override this method because restoring the title property to is default value needed to be handled specially
    
    See Also:
    ComponentInstance.createChangedPropList()
  - render
```
public int render()
           throws java.lang.NoSuchMethodException,
                  java.lang.IllegalAccessException,
                  java.lang.reflect.InvocationTargetException
```
    Needed to override this method to cache original values for data, readonly, required and applink
    
    Overrides:
    
    render in class DynamicAttributeComponent
    
    Throws:
    
    java.lang.NoSuchMethodException
    
    java.lang.IllegalAccessException
    
    java.lang.reflect.InvocationTargetException
    See Also:
    ComponentInstance.render()
  - getDataValueInError
```
public java.lang.String getDataValueInError()
```
    Used to get the invalid value entered into component
    
    Parameters:
    comp -
  - setDataValueInError
```
public void setDataValueInError(java.lang.String s)
```
    Used to set/store an invalid value entered into component
  - getLinkBack
```
public ComponentInstance getLinkBack()
```
    Used to get the original component in a linkedcomponent scenario
  - dataRestrictionCheck
```
public boolean dataRestrictionCheck()
```
    Returns true if there is a field level data restriction on the attribute preventing the control from being visible.
  - increment
```
public int increment()
```
    Called from front end when the field data type is DATE, TIME of DATETIME This even can only be called when user presses UP_ARROW keys on date fields.
    
    Returns:
    WebClientBean.EVENT_HANDLED
  - decrement
```
public int decrement()
              throws MXException
```
    Called from front end when the field data type is DATE, TIME of DATETIME This even can only be called when user presses DOWN_ARROW keys on date fields.
    
    Returns:
    WebClientBean.EVENT_HANDLED
    
    Throws:
    
    MXException
  - setcurrentdate
```
public int setcurrentdate()
                   throws MXException
```
    Called from front end when the field data type is DATE, TIME of DATETIME This even can only be called when user presses SHIFT + 7 (for &) or SHIFT + UP ARROW
    
    Returns:
    WebClientBean.EVENT_HANDLED
    
    Throws:
    
    MXException
    Since:
    
    Maximo7.1.1.5
  - setBoundAsRequired
```
public void setBoundAsRequired()
```
    Deprecated. This method is no longer needed as the boundAsRequired is not longer needed. Instead call madeRequiredConditionally on the DataBean the component is bound to.
    
    Set boundAsRequired equal to true, which states that the databean think this component's attribute is required.
  - popexception
```
public int popexception()
                 throws java.io.IOException,
                        MXException
```
    This event is called when use hovers the mouse over the error or warning icon. This returns input id and exception on which is to be shown.
    
    Throws:
    
    java.io.IOException
    
    MXException
  - getExceptionType
```
public int getExceptionType()
```
    Returns the exception type if any attached to this component.
    
    Returns:
    exception type {EXCEPTION_WARNING | EXCEPTION_ERROR | EXCEPTION_NONE}
  - removeCurrentError
```
public void removeCurrentError()
```
  - getWarningMessages
```
public java.lang.String getWarningMessages()
```
    Returns warning messages tied to this component if any
  - processAsyncYesNoCancel
```
public int processAsyncYesNoCancel()
```
    Handle the async error tool tip dialog yes/no/cancel button click event
  - processRevert
```
public int processRevert()
```
    Handle the async error tool tip dialog "Go Back" button click event
    
    Returns:
    WebClientBean.EVENT_HANDLED
  - processIgnoreWarning
```
public int processIgnoreWarning()
```
    Handle the async error tool tip dialog "Use My Value" button click event
  - processEdit
```
public int processEdit()
```
    Handle the async error tool tip dialog "Edit My Value" button click event
  - isRevert
```
public boolean isRevert()
```
    Check if Revert button is clicked
  - resetIsRevert
```
public void resetIsRevert()
```
    Reset the revertvalue
  - hasWarnings
```
public boolean hasWarnings()
```
    Check if warning exists
  - getCurrentError
```
public SetValueError getCurrentError()
```
    Returns the current SetValueError for this BoundComponent. A BoundComponent can have multiple errors if it's within a table. There could be an error for the same attribute on different rows (mbos) in the table. Also if the table the bound component is within is a child table to another table, so the MboSet the bound component is "bound" to can change as well. So This will return the SetValueError that matches the mboset and row the bound component is currently bound to.
    
    Returns:
    the current SetValueError for this BoundComponent
  - addAttributeError
```
public void addAttributeError(ERMAttributeError attributeError)
```
    Adds the ERMAttributeError to the BoundComponents error list if the BoundCOmponent does not have another error.
  - addSetValueError
```
public void addSetValueError(SetValueError error)
```
    Adds the SetValueError to the components error list and also bubbles the error up thru the parent container controls. If the list already contains an error for the same Mbo and attribute then the existing error is removed and invalidated.
  - getWarningList
```
public java.util.List<MXException> getWarningList()
```
    Returns the warning list
  - getHighestErrorLevel
```
public int getHighestErrorLevel()
```
    validates all errors associated with the boundcomponent (there can be multiple if the component is within a table) and returns the highest error level.
    
    Returns:
    The hight error level for the component.
  - clearErrors
```
public void clearErrors()
```
    Removes all SetValueErrors associated with this BoundComponent
  - getExcDialogIcon
```
public java.lang.String getExcDialogIcon(int exceptionType)
```
    Get tooltip dialog error icon
    
    Returns:
    icon filename with path
  - isPasswordField
```
public boolean isPasswordField()
```
    Check if the field is password field Return true if this is a password field
  - retryErrorValues
```
public boolean retryErrorValues()
```
    This method will loop thru all the errors set on the BoundComponent and try setting the errored values again. If the value are taken (no errors) then the error is removed otherwise the original error is replaced by the new one.
    
    Returns:
    true if the componented still has errors, false if it doesn't.
  - getErrorForRow
```
public SetValueError getErrorForRow(int row)
```
    Return the error level for the error assiciated with the passed in row. If there isn't an error for tha row EXCEPION_NONE is returned.
  - isSmartFillEnabled
```
public boolean isSmartFillEnabled(MboValueData mvd)
```
    Returns true if the BoundComponentInstance is smartfill enabled.
    
    Parameters:
    mvd - The MboValueData to check to see if it has a lookup defined
  - getFieldInfo
```
public com.ibm.json.java.JSONObject getFieldInfo()
```
    Returns data type information about this attribute to be added as an attribute on a field
  - useMaxLength
```
public boolean useMaxLength()
```
    used to determine whether we can limit the number of entered characters in a field if there is a domain and it has more than the key used in the typeahead we cannot limit so that typeahead searching will work
    
    Returns:
  - getRenderIdForAutoFill
```
public java.lang.String getRenderIdForAutoFill()
```
    Returns the renderid to be used by the autofill info. If the component is on a table row the id will be in this format: (render id of the component}|{render id of the table body component}

Class BoundComponentInstance

Property Summary

Properties inherited from class psdi.webclient.system.controller.ComponentInstance

Field Summary

Fields inherited from class psdi.webclient.system.controller.DynamicAttributeComponent

Fields inherited from class psdi.webclient.system.controller.ComponentInstance

Fields inherited from class psdi.webclient.system.controller.BaseInstance

Constructor Summary

Method Summary

Methods inherited from class psdi.webclient.system.controller.DynamicAttributeComponent

Methods inherited from class psdi.webclient.system.controller.ComponentInstance

Methods inherited from class psdi.webclient.system.controller.BaseInstance

Methods inherited from class java.lang.Object

Field Detail

ID

CSS_CLASS

DATA_ATTRIBUTE

DOMAIN

KEY

TYPEAHEADATTRS

REMARKS

TITLE

QUERY

LENGTH

TRUELENGTH

SCALE

IS_NUMERIC

HAS_LONG_DESCRIPTION

INT_TYPE

IS_PERSISTENT

ENTITY_NAME

OBJECT_NAME

ATTRIBUTE_NAME

COLUMN_NAME

BOUND_LABEL

FIELD_LABEL

HIDE_LABEL

INTERNAL

LABEL

DEFAULT_LABEL

SIZE

LABELFORMAT

INVALID_BINDING

BAD_BINDING_CSS

LONGDESC_ATTRIBUTE_SUFFIX

EVENT_PRIORITY

TAKESVALUE

SYNCHRONOUS

PRIORITY_DATATYPE

PRIORITY_VALIDATION

PRIORITY_FLUSH

bound

Constructor Detail

BoundComponentInstance

Method Detail

updateCachedDataValue

hasChanged

hasDataChanged

hasLongDescChanged

hasReadonlyChanged

hasRequiredChanged

setDataValid

isDataValid

getInputMode

getInputModeWithoutPasswordPrefix

initialize

getString

getBoolean

readOnlyCheck

isReadOnly

isRequired

getLongDescription

hasLongDescription

applink

selectvalue

isOnCurrentRow

isRowDeleted

getQbeNameWithPrepend

processProfile

getDataBean