psdi.webclient.system.beans

Class DataBean

    • Field Detail

      • MAX_TABLEROWS

        public static final int MAX_TABLEROWS
        the types of structurechanged events that can be triggered.
        See Also:
        Constant Field Values
      • LOG_CATEGORY

        protected static final Category LOG_CATEGORY
      • mboSetRemote

        protected MboSetRemote mboSetRemote
        Remote mboSet object reference used to pull data from mbo.
      • alwaysSelected

        protected boolean alwaysSelected
      • removeOnCancel

        protected int removeOnCancel
      • saveCount

        protected int saveCount
      • attributes

        protected java.util.Map attributes
        List of mbo set columns for which data needs to be fetched
      • tableAttributes

        protected java.util.Set tableAttributes
        List of mbo set columns for which data needs to be fetched when reading in table (bulk fetch) mode. Bulk fetch is set automatically when there is at least one attribute that has its ATTR_COLUMN flag set. DataBean recognizes bulk fetch mode by checking tableAttributes for not null
      • resetList

        protected java.util.Set resetList
        If an attribute is added to this set, any change in the attribute value will fire a structure changed event. The event is also triggered during delete if resetList is not null without regard to the contents
      • refreshList

        protected java.util.Set refreshList
        If an attribute is added to this set, any change in the attribute value will trigger a refresh of all table rows. A refresh is also triggered during delete if refreshList is not null without regard to the contents
      • requiredFields

        protected java.util.Set requiredFields
        These fields will have the REQUIRED flag forced on them on the mbo passed to setCurrentRecordData
      • conditionallyRequired

        protected java.util.Set conditionallyRequired
        These are attributes that were made required conditionally
      • zombieData

        protected MboData zombieData
      • tableData

        protected java.util.List tableData
      • currentRecordData

        protected MboData currentRecordData
      • appName

        protected java.lang.String appName
      • currentRow

        protected int currentRow
        Current row index to the cachedRows.
      • keyAttribute

        protected java.lang.String keyAttribute
      • keyAttributes

        protected java.lang.String[] keyAttributes
      • mboName

        protected java.lang.String mboName
        Name of the Mbo, for which the remote mboSet object reference is obtained, if the mboSetRemote member is not set.
      • userWhereClause

        protected java.lang.String userWhereClause
        User restrictions on the data.
      • appWhere

        protected java.lang.String appWhere
        App restrictions on the data.
      • orderBy

        protected java.lang.String orderBy
        User intended order of data.
      • defaultOrderBy

        protected java.lang.String defaultOrderBy
        User intended order of data.
      • listeners

        protected java.util.Vector listeners
        List of isteners interested in data changes.
      • parentRelationship

        protected java.lang.String parentRelationship
        The relationship this mboset has with it's parent.
      • parent

        protected DataBean parent
        If this MboSet is a child to another MboSet parentRelationship is the field in the MboSet that is related to the parent.
      • resetRemote

        protected boolean resetRemote
        flag that tells the DataBean that it need to reestablish it's MboSetRemote from the parent DataBean
      • boundInputs

        @Deprecated
        protected java.util.Map boundInputs
        Deprecated. FIREFOX
        Map of inputs bound to the DataBean, contains depreciated BoundControl instances keyed on control Id
      • boundAttributes

        protected java.util.Map boundAttributes
        Map of BoundAttribute keyed on (bound) component id
      • newRowUnedited

        protected boolean newRowUnedited
      • tableStateFlags

        protected BitFlag tableStateFlags
        Flags that can be set by the client/ClientUI
      • tableDataInvalid

        protected boolean tableDataInvalid
        flag telling the the DataBean is needs to refresh it's data
      • refreshQbe

        protected boolean refreshQbe
        flag telling the the DataBean is needs to refresh it's qbe data
      • qbeAttributes

        protected java.util.Hashtable qbeAttributes
        List of qbe attributes for which data needs to be fetched.
      • defaultQbe

        protected java.util.Hashtable defaultQbe
        Qbe setting stored after initialize has been called.
      • savedQbeAttributes

        protected java.util.Hashtable savedQbeAttributes
        saved list List of qbe attributes.
      • savedFilterSettings

        protected java.util.Hashtable savedFilterSettings
        save list of filter settings.
      • multiQbe

        protected java.lang.String multiQbe
        String containing any mutli-search Qbe
      • closingBean

        protected boolean closingBean
      • startrow

        protected int startrow
      • lastfetchedindex

        protected int lastfetchedindex
      • hasTableData

        protected boolean hasTableData
      • rowsperpage

        protected int rowsperpage
      • eventrow

        protected int eventrow
      • dialogReferences

        protected int dialogReferences
      • smartFillValue

        protected java.lang.String smartFillValue
      • fetchData

        protected boolean fetchData
        A flag telling the the DataBean not to fetch any data. Set by the startempty property on the control instantiating the bean. On any change initiated by this bean the flag will be set to true, thus allowing the table to fetch data. Mainly used by tables on dialog pages where the table starts out empty and prompts the user to filter the table to retrieve the data.
      • returnAttribute

        protected java.lang.String returnAttribute
      • returnComponentlId

        protected java.lang.String returnComponentlId
      • descAttributeId

        protected java.lang.String descAttributeId
      • esigvalidated

        protected boolean esigvalidated
      • mbosetfromzombie

        protected boolean mbosetfromzombie
      • currentQuery

        protected java.lang.String currentQuery
      • currentQueryDescription

        protected java.lang.String currentQueryDescription
      • startEmpty

        protected java.lang.String startEmpty
      • qualrestrict

        protected java.lang.String qualrestrict
      • screenDesignMode

        protected boolean screenDesignMode
      • designerMboName

        protected java.lang.String designerMboName
      • emptyOnClear

        protected boolean emptyOnClear
      • hasUnappliedAppDefaults

        protected boolean hasUnappliedAppDefaults
      • hasUnappliedQbeDefaults

        protected boolean hasUnappliedQbeDefaults
      • propCache

        protected CtrlCondPropCache propCache
        Deprecated. use ConditionalUIHelper getPropsFromPropertyCache
      • dynamicDefaults

        protected java.util.HashMap dynamicDefaults
      • defaultDynamicQbe

        protected java.util.HashMap defaultDynamicQbe
      • userQbeNotCommited

        protected boolean userQbeNotCommited
      • queryNameBeforeReviseAction

        protected java.lang.String queryNameBeforeReviseAction
      • queryDescBeforeReviseAction

        protected java.lang.String queryDescBeforeReviseAction
      • listTableRetain

        protected boolean listTableRetain
      • listTableModified

        protected boolean listTableModified
      • globalAppTableRetain

        protected boolean globalAppTableRetain
      • appDefaultValues

        protected java.util.Map appDefaultValues
        Private storage of attribute names and values for insert default's
      • defaultUserValues

        protected java.util.Map defaultUserValues
    • Constructor Detail

      • DataBean

        public DataBean()
        Default constructor.
    • Method Detail

      • setupBean

        public void setupBean(WebClientSession wcs)
        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.
        Specified by:
        setupBean in class WebClientBean
        Parameters:
        wsc - clientSession for the user.
      • bindComponent

        public void bindComponent(BoundComponentInstance boundComponent)
        Parameters:
        boundComopnentId - the identifier of the component instance to be bound to this bean
      • unbindComponent

        public void unbindComponent(BoundComponentInstance boundComponent)
        Parameters:
        boundComopnentId - the identifier of the component instance to be bound to this bean
      • setupNonPersistent

        protected boolean setupNonPersistent()
                                      throws MXException,
                                             java.rmi.RemoteException
        If the Mbo set associated with the data bean is a non-persistent set, call setup() and return true if the call succeeded
        Returns:
        true if the Mbo set associated with the data bean is a non-persistent set and has been reset successfully
        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 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.
        Throws:
        MXException
        java.rmi.RemoteException
      • setNewRowUnedited

        public void setNewRowUnedited(boolean unedited)
      • isNewRowUnedited

        public boolean isNewRowUnedited()
      • getTableAttributes

        public java.lang.String[] getTableAttributes()
      • setAppDefault

        public void setAppDefault(java.lang.String attribute,
                                  java.lang.String value)
        Called by AppDefaultTag to set insert default values from tags
      • setQbeDefaults

        public void setQbeDefaults()
        calls setQbe for all default qbes.
      • setAppDefaults

        public void setAppDefaults()
        Calls the MboSetRemote method setDefaultValues to set the JSP app defaults for the MboSet.
      • setParent

        public void setParent(DataBean parent,
                              java.lang.String parentRelationship)
        Sets the parent DataBean which this bean has a relationship to.
      • getParent

        public DataBean getParent()
        gets the DataBean that this bean is listening to. (This is DataBean that this DataBean is listening to.)
      • addListener

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

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

        public void fireDataChangedEvent(DataBean speaker)
        tells all listeners that this DataBean mbo data has changed or been refreshed
      • fireDataChangedEvent

        public void fireDataChangedEvent()
        tells all listeners that this DataBean mbo data has changed or been refreshed
      • fireStructureChangedEvent

        public void fireStructureChangedEvent(DataBean speaker)
        tells all listeners that this DataBean refrerences a new mbo or mboSetRemote
      • sendRefreshTable

        public void sendRefreshTable()
        Sends the refreshTable event to all listeners than are dataBeans
      • fireStructureChangedEvent

        public void fireStructureChangedEvent()
        tells all listeners that this DataBean references a new mbo or mboSetRemote
      • listenerChangedEvent

        public void listenerChangedEvent(DataBean speaker)
        event called by the listeners which tells this DataBean that the child's data has changed (mbo added, mdo deleted, mbo modified). If there is no "parent" DataBean then the dirty flag is set and the fireDataChangedEvent is called thus setting the invalidData for all the "children" DataBeans
      • dataChangedEvent

        public void dataChangedEvent(DataBean speaker)
        event called by the "parent" DataBean which tells this DataBean that it's mbo data (the parent's) has changed or been refreshed. The fireDataChangedEvent is called thus setting the invalidData for all the "children" DataBeans
        Specified by:
        dataChangedEvent in interface DataBeanListener
      • structureChangedEvent

        public void structureChangedEvent(DataBean speaker)
        event called by the "parent" 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" DataBeans
        Specified by:
        structureChangedEvent in interface DataBeanListener
      • fireChildChangedEvent

        public void fireChildChangedEvent()
        Calls the "parent" DataBean's listenerChangedEvent.
      • setMboName

        public void setMboName(java.lang.String sMboName)
        Sets the business object name
      • getMboName

        public java.lang.String getMboName()
        Returns the business object name
      • getMXSession

        public MXSession getMXSession()
        Returns a reference to the MXSession
      • setDefaultOrderBy

        public void setDefaultOrderBy(java.lang.String sOrderByClause)
                               throws MXException,
                                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getDefaultOrderBy

        public java.lang.String getDefaultOrderBy()
      • setOrderBy

        public void setOrderBy(java.lang.String sOrderByClause)
                        throws MXException,
                               java.rmi.RemoteException
        Sets the ORDER BY clause.
        Throws:
        MXException
        java.rmi.RemoteException
      • getOrderBy

        public java.lang.String getOrderBy()
        Returns the current ORDER BY clause
      • setAppWhere

        public void setAppWhere(java.lang.String sWhereClause)
                         throws MXException,
                                java.rmi.RemoteException
        Sets the application WHERE clause (app restrictions). If the reference to the remote MboSet exists, then applies the WHERE clause on the remote object. This function throws MXException or RemoteException, if it fails to set the WHERE clause.
        Throws:
        MXException
        java.rmi.RemoteException
      • getAppWhere

        public java.lang.String getAppWhere()
                                     throws MXException,
                                            java.rmi.RemoteException
        Returns the application defined where clause that overrides the QBE.
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboSetRemote

        protected MboSetRemote getMboSetRemote()
                                        throws MXException,
                                               java.rmi.RemoteException
        Obtains and returns a MboSetRemote using the mboname of parent/relationship setup for the bean. Override this method if the DataBean needs to get a MboSetRemote in a non-standard way. (Not via a the MXSession, or a relationship from another DataBean).
        Throws:
        MXException
        java.rmi.RemoteException
      • setERMOnMboSet

        protected void setERMOnMboSet()
                               throws java.rmi.RemoteException,
                                      MXException
        If the databean has a mboset and the mbosetremote does not have an owner, this method will check to see if there is an entity in the application's ERM and set it on the MboSetRemote. This will also set the required flags on the MboSet as defined in the ERMEntity.
        Throws:
        java.rmi.RemoteException - Throws if RMI calls to the MboSetRemote fail
        MXException - Thrown from the call to getOwner on the MboSetRemote
      • hasMboSetRemote

        public boolean hasMboSetRemote()
        This method will return true if the DataBean has a MboSetRemote. This method will not not obtain one if it doesn't or a get new one if the MboSetRemote has been marked invalid. Basically this will tell you if the DataBean has already obtained a MboSetRemote or not.
        Returns:
        whether or not the DataBean has a MboSetRemote
      • getMboSet

        public MboSetRemote getMboSet()
                               throws MXException,
                                      java.rmi.RemoteException
        Returns the reference to the remote MboSet. Checks to see if the DataBean has a mboSetRemote is it doesn't and the resetRemote flag is true it will try and obtain a MboSetRemote for the bean via the getMboSetRemote method. IMPORTANT: This method should not be overidden. Override getMboSetRemote if the bean needs to get a MboSetRemote in a "non-standard" way. But if it is absolutely necessary make sure to call the initalize() method after obtaining the MboSetRemote and to set the flag resetRemote = false.
        Throws:
        MXException
        java.rmi.RemoteException
      • resetDataBean

        protected void resetDataBean()
      • setApp

        public void setApp(java.lang.String appName)
                    throws java.rmi.RemoteException
        Sets the name of the application using this MboSet.
        Throws:
        java.rmi.RemoteException
      • setApp

        protected void setApp()
                       throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getKeyAttribute

        public java.lang.String getKeyAttribute()
        Returns the key Attribute for the MboSet. In the case that there are more than one key attribute, the first key attribute (which is suppose to be the primary key for the table) is returned.
      • getKeyAttributes

        public java.lang.String[] getKeyAttributes()
        Returns a String array of the key attributes of the MboSet
      • getAttributes

        public java.lang.String[] getAttributes()
        Returns a String array of attributes.
      • isAttribute

        public boolean isAttribute(java.lang.String attribute)
        Checks whether the given attribute is in the list of attributes that are currently set to this DataBean. Returns true, if the attribute is in the list, otherwise false.
      • isTableAttribute

        public boolean isTableAttribute(java.lang.String attribute)
      • addAttribute

        public void addAttribute(java.lang.String attribute,
                                 BitFlag flags)
        Adds the attribute to the internal attribute list.
      • addQbeAttribute

        public void addQbeAttribute(java.lang.String attribute)
        Adds the qbe attribute to the internal attribute list.
      • setAttributes

        public void setAttributes(java.lang.String[] attributelist,
                                  BitFlag[] flags)
        Replaces the internal attribute list with the new attributes.
      • clearQbeAttributes

        protected void clearQbeAttributes()
      • cleanup

        protected void cleanup()
        Removes all the attributes from the DataBean.
        Overrides:
        cleanup in class WebClientBean
      • count

        public int count()
                  throws MXException,
                         java.rmi.RemoteException
        Returns the number of rows available on the remote Mbo object. This function throws MXException or RemoteException if the information could not be obtained.
        Throws:
        MXException
        java.rmi.RemoteException
      • setUserWhere

        public void setUserWhere(java.lang.String whereClause)
                          throws MXException
        Sets the userwhereclause
        Throws:
        MXException
      • getUserWhere

        public java.lang.String getUserWhere()
                                      throws MXException,
                                             java.rmi.RemoteException
        Returns the user defined where clause
        Throws:
        MXException
        java.rmi.RemoteException
      • getUserAndQbeWhere

        public java.lang.String getUserAndQbeWhere()
                                            throws MXException,
                                                   java.rmi.RemoteException
        Returns the user defined and qbe defined where clause
        Throws:
        MXException
        java.rmi.RemoteException
      • invalidateTableData

        protected void invalidateTableData()
      • useStoredQuery

        public void useStoredQuery(java.lang.String queryName)
                            throws MXException,
                                   java.rmi.RemoteException
        Uses the stored query as the user defined query that overrides the QBE.
        Throws:
        MXException
        java.rmi.RemoteException
      • getQbe

        public java.lang.String getQbe(java.lang.String attribute)
        Returns the QBE (Query By Example) associated with the attribute. The QBE must have been set using the setQbe method. This function throws MXException or RemoteException if the Qbe could not be obtained for the attribute.
      • saveCurrentQbeSettings

        public void saveCurrentQbeSettings(boolean forceOverride)
                                    throws MXException,
                                           java.rmi.RemoteException
        Stores the current qbe settings so they can be re-established at another time. This is used by table filtering to establish a "base" qbe setting to restore to when the user clears the filter.
        Throws:
        MXException
        java.rmi.RemoteException
      • clearSavedQbeSettings

        public void clearSavedQbeSettings()
        Clears out the saved qbe settings.
      • restoreSavedQbeSettings

        public void restoreSavedQbeSettings()
                                     throws MXException,
                                            java.rmi.RemoteException
        clears out the user where (which clears all qbe fields) and restores the setting saved when saveCurrentQbeSetting() was called.
        Throws:
        MXException
        java.rmi.RemoteException
      • clearSavedFilterSettings

        public void clearSavedFilterSettings()
      • setQbe

        public void setQbe(java.lang.String attribute,
                           java.lang.String expression)
                    throws MXException
        Sets a QBE expression to the attribute. Result set will be based on this expression. This function throws MXException or RemoteException if the Qbe could not be set on the attribute.
        Throws:
        MXException
      • setQbe

        public void setQbe(java.lang.String attribute,
                           MboSetRemote expression)
                    throws MXException
        Sets a QBE expression to the list of selected mbos in the passed in MboSetRemote. This function throws MXException or RemoteException if the Qbe could not be set on the attribute.
        Throws:
        MXException
      • setQbe

        public void setQbe(java.lang.String[] attributes,
                           java.lang.String expression)
                    throws MXException,
                           java.rmi.RemoteException
        Sets a QBE expression to the list of attributes. Same QBE expression is applied to all the attributes and the expressions are ORed. Result set will be based on this expression. This function throws MXException or RemoteException if the Qbe could not be set on the attribute.
        Throws:
        MXException
        java.rmi.RemoteException
      • setQbe

        public void setQbe(java.util.Hashtable qbeAttrs)
                    throws MXException,
                           java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • setDefaultQbe

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

        public void setQbe(java.lang.String expression)
                    throws MXException,
                           java.rmi.RemoteException
        Sets a Qbe on all the fields which have been added to the MboSet
        Throws:
        MXException
        java.rmi.RemoteException
      • getQbe

        public java.lang.String getQbe()
                                throws MXException,
                                       java.rmi.RemoteException
        Get the multi-search QBE value
        Throws:
        MXException
        java.rmi.RemoteException
      • getQbeAttributes

        public java.util.Hashtable getQbeAttributes()
        Gets the current qbe attributes This is used by the qbe page to get the qbe settings from the search remote and apply them to the results bean
      • setQbeAttributes

        public void setQbeAttributes(java.util.Hashtable newQbeAttributes)
                              throws MXException
        Sets the current qbe attributes This is used by the qbe page to get the qbe settings from the search remote and apply them to the results bean
        Throws:
        MXException
      • setQbeExactMatch

        public void setQbeExactMatch(boolean exact)
                              throws MXException,
                                     java.rmi.RemoteException
        Sets whether the QBE needs to be an exact match or not. This function throws MXException or RemoteException if the exact match could not be set.
        Throws:
        MXException
        java.rmi.RemoteException
      • setQbeCaseSensitive

        public void setQbeCaseSensitive(boolean caseSensitive)
                                 throws MXException,
                                        java.rmi.RemoteException
        Sets whether the QBE needs to be case sensitive or not. This function throws MXException or RemoteException if the case sensitivity could not be set.
        Throws:
        MXException
        java.rmi.RemoteException
      • resetQbe

        public void resetQbe()
                      throws MXException,
                             java.rmi.RemoteException
        Resets the QBE expressions. This function throws MXException or RemoteException if the Qbe could not be set on the attribute.
        Throws:
        MXException
        java.rmi.RemoteException
      • getBoolean

        public boolean getBoolean(java.lang.String col)
                           throws MXException,
                                  java.rmi.RemoteException
        Return the boolean value for the specified column in the current row
        Throws:
        MXException
        java.rmi.RemoteException
      • getBoolean

        public boolean getBoolean(int row,
                                  java.lang.String col)
                           throws MXException,
                                  java.rmi.RemoteException
        Return the boolean value for the specified column in the specified row
        Throws:
        MXException
        java.rmi.RemoteException
      • getString

        public java.lang.String getString(java.lang.String attribute)
        Return the string for the specified column in the current row
      • getString

        public java.lang.String getString(int row,
                                          java.lang.String attribute)
        Return the string for the specified column in the specified row
      • getColumnString

        public java.lang.String getColumnString(int row,
                                                java.lang.String col)
                                         throws MXException,
                                                java.rmi.RemoteException
        Return the string for the specified column in the specified row
        Throws:
        MXException
        java.rmi.RemoteException
      • getColumnDate

        public java.util.Date getColumnDate(int row,
                                            java.lang.String col)
                                     throws MXException,
                                            java.rmi.RemoteException
        Return the date for the specified column in the specified row
        Throws:
        MXException
        java.rmi.RemoteException
      • getDate

        public java.util.Date getDate(java.lang.String attribute)
                               throws MXException,
                                      java.rmi.RemoteException
        Return the date for the requested attribute
        Throws:
        MXException
        java.rmi.RemoteException
      • getTitle

        public java.lang.String getTitle(java.lang.String attribute)
                                  throws MXException,
                                         java.rmi.RemoteException
        Gets the title from the MboValueInfoStatic for the requested attribute
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboOrZombie

        public MboRemote getMboOrZombie()
                                 throws MXException,
                                        java.rmi.RemoteException
        Returns either the current mbo of a mboset or the mboset's zombie mbo if there isn't a current mbo.
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboValueInfo

        public MboValueInfoStatic getMboValueInfo(java.lang.String attribute)
                                           throws MXException,
                                                  java.rmi.RemoteException
        Gets the MboValueInfoStatic for requested attribute
        Throws:
        MXException
        java.rmi.RemoteException
      • getZombieMboValueData

        public MboValueData getZombieMboValueData(java.lang.String attribute)
                                           throws MXException,
                                                  java.rmi.RemoteException
        Gets the requested attribute's MboValueData from the mboSet's zombie mbo.
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboValueData

        public MboValueData getMboValueData(int nRow,
                                            java.lang.String attribute)
                                     throws MXException,
                                            java.rmi.RemoteException
        Gets the requested attribute's data on a given row from the cache. If the requested row is not in the cache, then null is returned
        Throws:
        MXException
        java.rmi.RemoteException
      • isAttributeHidden

        public boolean isAttributeHidden(java.lang.String attribute)
                                  throws java.rmi.RemoteException,
                                         MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • isAttributeHidden

        public boolean isAttributeHidden(int row,
                                         java.lang.String attribute)
                                  throws java.rmi.RemoteException,
                                         MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • isMboHidden

        public boolean isMboHidden()
                            throws java.rmi.RemoteException,
                                   MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • isMboHidden

        public boolean isMboHidden(int row)
                            throws java.rmi.RemoteException,
                                   MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • getMboValueData

        public MboValueData getMboValueData(java.lang.String attribute)
                                     throws MXException,
                                            java.rmi.RemoteException
        Returns the MboValueData associated with the attribute for the current row.
        Throws:
        MXException
        java.rmi.RemoteException
      • getRemoteForLookup

        public MboSetRemote getRemoteForLookup()
                                        throws MXException,
                                               java.rmi.RemoteException
        Return the MboSetRemote used by a lookup off a field of the bean. Assumes that the returnControlId and the returnAttribute have been set. If the field is a query or default field then the getList call will be on the MboSet's zombie mbo. Other wise getList is called on the current mbo.
        Throws:
        MXException
        java.rmi.RemoteException
      • getList

        public MboSetRemote getList(java.lang.String attribute)
                             throws MXException,
                                    java.rmi.RemoteException
        Returns the Remote reference to the Mbo object (valuelist) associated with the attribute for the current row.
        Throws:
        MXException
        java.rmi.RemoteException
      • getList

        public MboSetRemote getList(java.lang.Integer row,
                                    java.lang.String attribute)
                             throws MXException,
                                    java.rmi.RemoteException
        Returns the Remote reference to the Mbo object (valuelist) associated with the attribute for row.
        Throws:
        MXException
        java.rmi.RemoteException
      • getList

        public MboSetRemote getList(int nRow,
                                    java.lang.String attribute)
                             throws MXException,
                                    java.rmi.RemoteException
        Returns the Remote reference to the Mbo object (valuelist) associated with the attribute for row.
        Throws:
        MXException
        java.rmi.RemoteException
      • getDataList

        public java.lang.String[][] getDataList(java.lang.String dataAttribute)
                                         throws MXException,
                                                java.rmi.RemoteException
        Returns a 2 dimensional String array of valid data, display values for use by controls such as combobox
        Throws:
        MXException
        java.rmi.RemoteException
      • getDataList

        public java.lang.String[][] getDataList(int row,
                                                java.lang.String dataAttribute)
                                         throws MXException,
                                                java.rmi.RemoteException
        Returns a 2 dimensional String array of valid data, display values for use by controls such as combobox
        Throws:
        MXException
        java.rmi.RemoteException
      • getDataList

        public java.lang.String[][] getDataList(int row,
                                                java.lang.String dataAttribute,
                                                java.lang.String keyAttributeName,
                                                java.lang.String displayAttribute)
                                         throws MXException,
                                                java.rmi.RemoteException
        Parameters:
        the - row when the combo box is on a table
        dataAttribute - the name of the data attribute in this bean - the contents will be retrieved from the data source associated with the control bound to this attribute
        keyAttributeName - the name of the key attribute in the data source. If null, dataAttribute is used instead
        displayAttribute - teh name of the value in the data source . If null, dataAttribute is used instead
        Returns:
        a 2 dimensional String array of valid data, display values for use by controls such as combobox
        Throws:
        MXException - or RemoteException if the data could not be obtained.
        java.rmi.RemoteException
      • getDataList

        public java.lang.String[][] getDataList(int row,
                                                java.lang.String dataAttribute,
                                                java.lang.String displayAttribute)
                                         throws MXException,
                                                java.rmi.RemoteException
        Returns a 2 dimensional String array of valid data, display values for use by controls such as combobox Throws MXException or RemoteException if the data could not be obtained.
        Throws:
        MXException
        java.rmi.RemoteException
      • getDataListFromMboSetRemote

        public java.lang.String[][] getDataListFromMboSetRemote(MboSetRemote setRemote,
                                                                java.lang.String dataAttribute,
                                                                java.lang.String displayAttribute)
                                                         throws MXException,
                                                                java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • validate

        public void validate()
                      throws MXException,
                             java.rmi.RemoteException
        Validates object.
        Throws:
        MXException
        java.rmi.RemoteException
      • validateMbo

        public void validateMbo()
                         throws MXException,
                                java.rmi.RemoteException
        Validates object.
        Throws:
        MXException
        java.rmi.RemoteException
      • validateChildren

        public void validateChildren()
                              throws MXException,
                                     java.rmi.RemoteException
        Validates children of the current table.
        Throws:
        MXException
        java.rmi.RemoteException
      • checkAndDistributeRequiredError

        public MXException checkAndDistributeRequiredError(MXException mxe)
        This method check to see inf the MXExcpetion passed in is a required field is blank exception and if it is, searches for other required fields. If there are other required fields without a value, then the exception is replaced with a new one with a message that has all the required fields listed. Also this method will mark all those required fields with an error so it will be easier for the user to find the fields. If the exception is not a required field is blank exception, then the passed in exception is returned. This method determnes if the exception is a required field is blank exception by either the MXException is and instance of MXRequiredFieldException or the MXExceptions error group is "system" and error key is "null".
        Parameters:
        mxe - The MXException to check and see if it is a required field is blank exception.
        Returns:
        Either the passed in MXException (if it is not a required field is blank exception) or a new MXException with all the required fields list that need a value.
        See Also:
        Appinstance.propagateRequiredErrors
      • handleRequiredFieldException

        public void handleRequiredFieldException(MXRequiredFieldException requiredFieldException,
                                                 WebClientEvent event)
        Deprecated. use checkAndDistributeRequiredError
        Parameters:
        requiredFieldException -
        event -
      • save

        public void save()
                  throws MXException
        Saves the changes made to the MboSet Throws MXException or RemoteException on failure The MboSet data or cached data will be undisturbed.
        Throws:
        MXException
      • preSaveChecks

        protected void preSaveChecks()
                              throws MXException
        A method that is called before the DataBean is saved. This method will check for asynce page errors that should prevent the saving of the app and any additional checks needed before saving.
        Throws:
        MXException
      • setCurrentRecordData

        protected void setCurrentRecordData(MboRemote mbo)
                                     throws MXException,
                                            java.rmi.RemoteException
        Sets current record data to be he Mbo data of the mbo in the parameter.

        Forces the REQUIRED flag on all fields found in requiredFields for the mbo in the parameter

        Throws:
        MXException
        java.rmi.RemoteException
      • save

        public void save(MboRemote mbo)
                  throws MXException,
                         java.rmi.RemoteException
        Saves the changes made to the MboSet taking in a MboRemote NOTE: This is used only for a NonPersistentMboSet The MboSet data or cached data will be undisturbed.
        Throws:
        MXException
        java.rmi.RemoteException
      • reset

        public void reset()
                   throws MXException
        Resets the MboSet. Clears the internal cache and fires a structure change event to all listeners.
        Throws:
        MXException
      • canCloseBean

        public boolean canCloseBean()
        Returns true if the databean doesn't have a mboSetRemote or it's current mboSetRemote is an instance of NonPersistentMboSetRemote, or the DataBean has a mboname. Otherwise false is returned. If the databean doesn't have a current mboSetRemote or the remote is invalid, this method doesn't not get a new one. It just looks at the current one the DataBean has. This method is called when a pageinstance is removed from the page stack and the appinstance want to know if the bean should be closed.
      • isMboSetSame

        protected boolean isMboSetSame(MboSetRemote msr)
      • hasSameMboSet

        public boolean hasSameMboSet(DataBean bean)
      • addDialogReference

        public void addDialogReference()
      • removeDialogReference

        public void removeDialogReference()
      • close

        public void close()
        Closes the MboSet. Throws MXException or RemoteException on failure
      • setCurrentRow

        public boolean setCurrentRow(int nRow)
                              throws MXException,
                                     java.rmi.RemoteException
        Changes the current row position. Returns true, if the row exists in the result set otherwise false.
        Throws:
        MXException
        java.rmi.RemoteException
      • moveTo

        protected boolean moveTo(int row)
                          throws MXException,
                                 java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getCurrentRow

        public int getCurrentRow()
        Returns the current row.
      • next

        public boolean next()
                     throws MXException,
                            java.rmi.RemoteException
        Advances the current row position. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • previous

        public boolean previous()
                         throws MXException,
                                java.rmi.RemoteException
        Decrements the current row position. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • insert

        public void insert(int nRow)
                    throws MXException,
                           java.rmi.RemoteException
        Inserts a row after the given row. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • insert

        public void insert()
                    throws MXException,
                           java.rmi.RemoteException
        Inserts a row at the begining of the MboSet. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • insertAtEnd

        public void insertAtEnd()
                         throws MXException,
                                java.rmi.RemoteException
        Inserts a row at the end of the MboSet. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • delete

        public void delete()
                    throws MXException,
                           java.rmi.RemoteException
        Deletes the current row. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • delete

        public void delete(int nRow)
                    throws MXException,
                           java.rmi.RemoteException
        Deletes the given row. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • deleteAndRemove

        public void deleteAndRemove()
                             throws MXException,
                                    java.rmi.RemoteException
        Deletes and removes the current row from the mboset. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • deleteAndRemove

        public void deleteAndRemove(int nRow)
                             throws MXException,
                                    java.rmi.RemoteException
        Deletes and removes the given row from the MboSet. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • undelete

        public void undelete()
                      throws MXException,
                             java.rmi.RemoteException
        Undeletes the current row. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • undelete

        public void undelete(int nRow)
                      throws MXException,
                             java.rmi.RemoteException
        undeletes the given row. Fires a row change event to all listeners upon success.
        Throws:
        MXException
        java.rmi.RemoteException
      • setDefaultValue

        public void setDefaultValue(java.lang.String attribute,
                                    MboRemote value)
                             throws MXException
        method for setting default values for a mboset
        Throws:
        MXException
      • setDefaultValue

        public void setDefaultValue(java.lang.String attribute,
                                    java.lang.String value)
                             throws MXException
        method for setting default values for a mboset
        Throws:
        MXException
      • setUserDefaults

        public void setUserDefaults()
                             throws MXException,
                                    java.rmi.RemoteException
        method for getting default value for a particular attribute in mboset
        Throws:
        MXException
        java.rmi.RemoteException
      • getDefaultValue

        public java.lang.String getDefaultValue(java.lang.String attribute)
        method for getting default value for a particular attribute in mboset
      • setValue

        public void setValue(java.lang.String attribute,
                             java.lang.String value)
                      throws MXException
        Updates an attribute's value on the current row. Fires a row change event to all the listeners upon success.
        Throws:
        MXException
      • setDate

        @Deprecated
        public void setDate(java.lang.String controlId,
                                        java.lang.String attribute,
                                        java.util.Date value)
                                 throws MXException
        Deprecated. FIREFOX
        Once this is removed, merge setDate and setDateInternal
        Throws:
        MXException
      • setDate

        public void setDate(java.lang.String componentId,
                            java.util.Date value)
                     throws MXException
        Updates an attribute's value (Date) on the current row. Fires a row change event to all the listeners upon success. Takes control id for search more query field Throws MXException or RemoteException on failure
        Throws:
        MXException
      • setValue

        public void setValue(int nRow,
                             java.lang.String attribute,
                             java.lang.String value)
                      throws MXException
        Updates an attribute's value on the given row. Fires a row change event to all the listeners upon success.
        Throws:
        MXException
      • setValue

        public void setValue(java.lang.String attribute,
                             java.lang.String value,
                             long accessModifier)
                      throws MXException
        Updates an attribute's value on the current row. Fires a row change event to all the listeners upon success.
        Throws:
        MXException
      • setValue

        public void setValue(int nRow,
                             java.lang.String attribute,
                             java.lang.String value,
                             long accessModifier)
                      throws MXException
        Updates an attribute's value on the given row. Fires a row change event to all the listeners upon success.
        Throws:
        MXException
      • afterSetValue

        protected void afterSetValue(java.lang.String attribute)
                              throws java.rmi.RemoteException,
                                     MXException
        This method is called right after a setValue on a mbo is performed. The setValue can occur in a number of methods so this method does the necessary refreshing and nofitication that the setValue happened.
        Throws:
        java.rmi.RemoteException
        MXException
      • setValue

        public void setValue(int row,
                             java.lang.String attribute,
                             MboRemote mboRemote)
                      throws MXException
        Updates an attribute's value on the given row. Fires a row change event to all the listeners upon success.
        Throws:
        MXException
      • setValue

        public void setValue(java.lang.String attribute,
                             MboSetRemote mboSetRemote)
                      throws MXException
        Updates an attribute's value on the given row. Fires a row change event to all the listeners upon success.
        Throws:
        MXException
      • returnLookupValue

        public int returnLookupValue(java.lang.String lookupValue)
                              throws MXException
        Throws:
        MXException
      • returnLookupValue

        @Deprecated
        public int returnLookupValue(java.lang.String componentId,
                                                 MboRemote lookupMbo)
                                          throws MXException
        Deprecated. - This methd is not needed. Call returnLookupValue(MboRemote lookupMbo) where this method expects the return component to be set via setReturnComponent method, prior to the call. preferably before launching the lookup or applink.
        Throws:
        MXException
      • getMbo

        public MboRemote getMbo()
                         throws MXException,
                                java.rmi.RemoteException
        Returns the MboRemote reference to the current Mbo.
        Throws:
        MXException
        java.rmi.RemoteException
      • getMbo

        public MboRemote getMbo(int row)
                         throws MXException,
                                java.rmi.RemoteException
        Returns the MboRemote reference for the given row.
        Throws:
        MXException
        java.rmi.RemoteException
      • duplicateMbo

        public boolean duplicateMbo()
                             throws MXException,
                                    java.rmi.RemoteException
        Duplicates the current mbo as a new mbo in the MboSet
        Throws:
        MXException
        java.rmi.RemoteException
      • getDataAsArray

        public java.lang.String[][] getDataAsArray()
        For each table attribute, this returns all rows of data in an array where the first level is the rows of data and the second level is the data for each of the attributes in that row. If there isn't data for a particular attribute in a row then "" is returned in the array for it's data. Also the first "row" in the array is the list of attributes used to retrieve the data for the array.
      • getDataAsArray

        public java.lang.String[][] getDataAsArray(java.lang.String[] attributeNames)
        For the given list of attributes, this returns all rows of data in an array where the first level is the rows of data and the second level is the data for each of the attributes in that row. If there isn't data for a particular attribute in a row then "" is returned in the array for it's data. Also the first "row" in the array is the list of attributes used to retrieve the data for the array.
      • getSelectedDataAsArray

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

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

        public void propagateRequired()
                               throws java.rmi.RemoteException,
                                      MXException
        Loops thru the in memory list of mbos and sets the required flag for all attributes marked as required by the presentation.
        Throws:
        java.rmi.RemoteException
        MXException
      • retainPosition

        public void retainPosition()
                            throws java.rmi.RemoteException,
                                   MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • fetchTableData

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

        public int fetchTableData(int startingRow)
                           throws MXException,
                                  java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • fetchRecordData

        public boolean fetchRecordData()
                                throws MXException,
                                       java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboSetData

        public MboSetData getMboSetData(int row,
                                        int count,
                                        java.lang.String[] attributeNames)
                                 throws MXException,
                                        java.rmi.RemoteException
        Fetches multiple row MboSetData
        Throws:
        MXException
        java.rmi.RemoteException
      • hasLongDescriptionText

        public boolean hasLongDescriptionText(int row,
                                              java.lang.String attribute)
        Returns whether the attribute has long description text.
      • hasLongDescriptionText

        public boolean hasLongDescriptionText(java.lang.String attribute)
        Returns whether the attribute has long description text.
      • toBeSaved

        public boolean toBeSaved()
                          throws MXException
        Returns whether the MboSet or it's children need to be saved.
        Throws:
        MXException
      • isRowDeleted

        public boolean isRowDeleted(int row)
        Returns whether the row is marked for delete or not.
      • isModifiedRow

        public boolean isModifiedRow()
        Returns whether the current row is modified or not
      • isModifiedRow

        public boolean isModifiedRow(int row)
        Returns whether the row is modified or not
      • hasRow

        public boolean hasRow(int row)
        Checks to see if the table has that row cached
      • isNewRow

        public boolean isNewRow()
        Returns whether the row is new or not
      • isNewRow

        public boolean isNewRow(int row)
        Returns whether the row is new or not
      • valueBound

        public void valueBound(javax.servlet.http.HttpSessionBindingEvent event)
        Specified by:
        valueBound in interface javax.servlet.http.HttpSessionBindingListener
      • valueUnbound

        public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent event)
        Specified by:
        valueUnbound in interface javax.servlet.http.HttpSessionBindingListener
      • select

        public void select(int row)
                    throws MXException
        Marks the Mbo at the specified row Selected.
        Throws:
        MXException
      • unselect

        public void unselect(int row)
                      throws MXException
        Marks the Mbo at the specified row Unselected.
        Throws:
        MXException
      • getSelection

        public java.util.Vector getSelection()
                                      throws MXException
        Returns a Vector of mbos marked for selection.
        Throws:
        MXException
      • selectAll

        public void selectAll()
                       throws MXException
        selects all Mbos on in the MboSet, remotely
        Throws:
        MXException
      • unselect

        public void unselect(int startIndex,
                             int count)
                      throws MXException
        Marks the a set of Mbos starting from startIndex Unselected.
        Parameters:
        startIndex - starting index position (must be >= 0)
        count - number of Mbos after the start index to be marked unselected (must be > 0).
        Throws:
        MXException
      • select

        public void select(int startIndex,
                           int count)
                    throws MXException
        Marks the a set of Mbos starting from startIndex selected.
        Parameters:
        startIndex - starting index position (must be >= 0)
        count - number of Mbos after the start index to be marked unselected (must be > 0).
        Throws:
        MXException
      • unselectAll

        public void unselectAll()
                         throws MXException
        Unselects all Mbos on in the MboSet, remotely
        Throws:
        MXException
      • selectRows

        public void selectRows(java.util.Vector selectMboRows,
                               java.util.Vector unselectMboRows)
                        throws MXException
        Sends two vectors (one a list of selected rows the other a list list of unselected rows) to select and unselect mbos in the MboSet
        Throws:
        MXException
      • resetWithSelection

        public void resetWithSelection()
                                throws MXException
        Filters the MboSet with the selected Mbos.
        Throws:
        MXException
      • sort

        public void sort()
                  throws MXException
        Used for sorting table windows. The method sets the ORDER BY clause, resets the MboSet, and moves to the first record. Uses defaultOrderBy (set via the initalize method).
        Throws:
        MXException
      • sort

        public void sort(java.lang.String sOrderByClause)
                  throws MXException
        Used for sorting table windows. The method sets the ORDER BY clause, resets the MboSet, and moves to the first record.
        Throws:
        MXException
      • isColumnSorted

        @Deprecated
        public int isColumnSorted(java.lang.String componentId)
                                       throws MXException
        Deprecated. FIREFEOX - Table control checks these
        No longer useful in FIREFOX project
        Throws:
        MXException
      • isEmpty

        public boolean isEmpty()
                        throws MXException,
                               java.rmi.RemoteException
        Returns try if mboset has no members
        Throws:
        MXException
        java.rmi.RemoteException
      • notExist

        public boolean notExist()
                         throws MXException,
                                java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • checkMethodAccess

        public boolean checkMethodAccess(java.lang.String methodName)
                                  throws MXException
        Check if the method name is available on the MboSetRemote. Will throw an MXAccessException if not available due to lack of rights, or if currently not available for this mbo. Will return false if the the DataBean doesn't have a MboSetRemote. Returns true if the method is avaliable.
        Throws:
        MXException
      • needToAuthenticate

        @Deprecated
        public boolean needToAuthenticate(SessionContext sc,
                                                      java.lang.String option)
                                               throws MXException,
                                                      java.rmi.RemoteException
        Deprecated. FIREFEOX - ckeckEsigAuthenticated is the new way
        (Never used in MXES, probably a legacy from Maximo 5; maybe some customized app/industry solution needs it?) Checks if authentication dialog needs to be thrown or not based on option
        Throws:
        MXException
        java.rmi.RemoteException
      • setShowDetails

        public void setShowDetails(boolean b)
        sets detailsopen flag to save details block state This is only storage between pages
      • validateRow

        protected void validateRow()
                            throws MXException,
                                   java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • validateClause

        protected void validateClause()
                               throws MXException,
                                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • setRemoveOnCancel

        public void setRemoveOnCancel(int row)
      • getLastFetchIndex

        public int getLastFetchIndex()
        Returns the last index for which data has been fethed.
      • getEndRow

        public int getEndRow()
        Returns the possible last row index where the table display ends. row is 0 based index.
      • getCacheRowIndex

        public int getCacheRowIndex(int rowDataBeanIndex)
      • getMboRowIndex

        public int getMboRowIndex(int tableRow)
      • getPageStartIndex

        public int getPageStartIndex()
        Returns the mbo index of the first row in the table
        Returns:
      • getRowIndexFromEvent

        public int getRowIndexFromEvent(WebClientEvent event)
      • hasPageRows

        public boolean hasPageRows()
      • removeRowOnCancel

        public boolean removeRowOnCancel(int row)
      • isTableRowSelected

        public boolean isTableRowSelected(int row)
        Returns whether the table row is marked for selection or not. Table rows are assumed to be 1 based while MboSetData is 0 based so the row is converted.
      • getShowDetails

        public boolean getShowDetails()
        Returns whether or not to show table details This is only storage between pages
      • getPageEndRow

        public int getPageEndRow()
        Returns the possible last row index where the table display ends. row is 1 based index.
      • getPageRowCount

        public int getPageRowCount()
        Returns the number of rows the page has.
      • applyValuesToSharedAttributes

        public boolean applyValuesToSharedAttributes(ComponentInstance component,
                                                     java.lang.String value)
        When we do a setvalue on a shared attribute we need to update the cached value on all of the BoundComponents that share it so they can update if they change. The passed in value should be the value from the client. This method returns true if one or more of the components are on a table row.
      • applyValuesToSharedAttributes

        public void applyValuesToSharedAttributes(ComponentInstance component)
        Deprecated. 
      • setvalue

        public int setvalue()
                     throws MXException,
                            java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • refreshFieldErrors

        public void refreshFieldErrors()
                                throws java.rmi.RemoteException,
                                       MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • getNullRequiedFields

        public java.util.List getNullRequiedFields()
                                            throws java.rmi.RemoteException,
                                                   MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • nextrow

        public int nextrow()
                    throws MXException,
                           java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • toggleselectrow

        public int toggleselectrow()
                            throws MXException,
                                   java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • toggleselectallrows

        public int toggleselectallrows()
                                throws MXException
        Marks all the mbos in the current table window page selected or unselected
        Throws:
        MXException
      • isTableStateFlagSet

        public boolean isTableStateFlagSet(long flag)
        Get the current value of a table state flag. Does NOT fetch data, just looks a the current bit flags.
        Parameters:
        flag - The flag to check
        Returns:
        true if the flag is set
      • getTableStateFlags

        public BitFlag getTableStateFlags()
      • selectrecord

        public int selectrecord()
                         throws MXException,
                                java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • resetJSPFlags

        public void resetJSPFlags()
      • getEventRowIndex

        public int getEventRowIndex()
        Returns:
        returns the current row index that is being drawn/refreshed by the UI Framework
      • setEventRowIndex

        public void setEventRowIndex(int i)
        Parameters:
        Used - by the UI Framework to set the current row being drawn/refreshed
      • getLastEventHandled

        public WebClientEvent getLastEventHandled()
        Returns:
      • setLastEventHandled

        public void setLastEventHandled(WebClientEvent event)
        Parameters:
        event -
      • setTableFlag

        public void setTableFlag(long flag,
                                 boolean value)
      • execute

        public int execute()
                    throws MXException,
                           java.rmi.RemoteException
        This method is meant to be overrided by dialog beans but by default if the bean's remote is a NonPersistentMboSetRemote, then execute is called on the bean's remote and if the DataBean has a parent then execute is called on the bean's parent bean. If the remote is not a NonPersistentMboSetRemote then if the bean has a parentbean and a parent relationship then execute is called on the parent bean, else save is called on the bean's remote If you do not want to save the parent of the bean then override execute and just call save.
        Throws:
        MXException
        java.rmi.RemoteException
      • callMethod

        public int callMethod(WebClientEvent event)
                       throws MXException,
                              java.lang.NoSuchMethodException,
                              java.rmi.RemoteException
        Throws:
        MXException
        java.lang.NoSuchMethodException
        java.rmi.RemoteException
      • callMethod

        public int callMethod(WebClientEvent event,
                              java.lang.Class[] paramTypes,
                              java.lang.Object[] params)
                       throws MXException,
                              java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • callMethod

        public int callMethod(java.lang.String methodName,
                              WebClientEvent event,
                              java.lang.Class[] paramTypes,
                              java.lang.Object[] params)
                       throws MXException,
                              java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • findAndCallMethod

        public int findAndCallMethod(WebClientEvent event,
                                     DataBean datasrc,
                                     java.lang.String method,
                                     java.lang.Class[] paramTypes,
                                     java.lang.Object[] params)
                              throws MXException,
                                     java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • callRemoteMethod

        public int callRemoteMethod(java.lang.String method)
                             throws MXException,
                                    java.lang.NoSuchMethodException,
                                    java.rmi.RemoteException
        Throws:
        MXException
        java.lang.NoSuchMethodException
        java.rmi.RemoteException
      • callRemoteMethod

        public int callRemoteMethod(java.lang.String method,
                                    java.lang.Class[] paramTypes,
                                    java.lang.Object[] params)
                             throws MXException,
                                    java.lang.NoSuchMethodException,
                                    java.rmi.RemoteException
        Throws:
        MXException
        java.lang.NoSuchMethodException
        java.rmi.RemoteException
      • callBeanMethod

        public int callBeanMethod(WebClientEvent event)
                           throws MXException,
                                  java.lang.NoSuchMethodException,
                                  java.rmi.RemoteException
        Throws:
        MXException
        java.lang.NoSuchMethodException
        java.rmi.RemoteException
      • callBeanMethod

        public int callBeanMethod(java.lang.String method,
                                  WebClientEvent event)
                           throws MXException,
                                  java.lang.NoSuchMethodException,
                                  java.rmi.RemoteException
        Throws:
        MXException
        java.lang.NoSuchMethodException
        java.rmi.RemoteException
      • callBeanMethod

        public int callBeanMethod(WebClientEvent event,
                                  java.lang.Class[] paramTypes,
                                  java.lang.Object[] params)
                           throws MXException,
                                  java.lang.NoSuchMethodException,
                                  java.rmi.RemoteException
        Throws:
        MXException
        java.lang.NoSuchMethodException
        java.rmi.RemoteException
      • callBeanMethod

        public int callBeanMethod(java.lang.String method,
                                  WebClientEvent event,
                                  java.lang.Class[] paramTypes,
                                  java.lang.Object[] params)
                           throws MXException,
                                  java.lang.NoSuchMethodException,
                                  java.rmi.RemoteException
        Throws:
        MXException
        java.lang.NoSuchMethodException
        java.rmi.RemoteException
      • getReturnAttribute

        public java.lang.String getReturnAttribute()
      • setReturnAttribute

        public void setReturnAttribute(java.lang.String string)
      • getReturnControlId

        @Deprecated
        public java.lang.String getReturnControlId()
        Deprecated. FIREFOX - use getReturnComponentId() instead
      • getReturnComponentId

        public java.lang.String getReturnComponentId()
      • setReturnControlId

        @Deprecated
        public void setReturnControlId(java.lang.String string)
        Deprecated. FIREFOX - use setReturnComponentId instead
      • setReturnComponentId

        public void setReturnComponentId(java.lang.String id)
      • handleRemoteException

        public void handleRemoteException(java.rmi.RemoteException e)
                                   throws MXException
        Throws:
        MXException
      • turnEmptyStateOn

        public void turnEmptyStateOn()
        Sets a flag telling the the DataBean not to fetch any data until an event on the DataBean causes a "refreshing" of the data (like filtering, setting of a value, etc...)
      • getMboForUniqueId

        public MboRemote getMboForUniqueId(long uid)
                                    throws MXException,
                                           java.rmi.RemoteException
        Filters down the DataBean to the mbo that has the passed in unique id. There should onlt be one mbo in the MboSet for the DataBean.
        Parameters:
        uid - unique id to look for.
        Throws:
        MXException
        java.rmi.RemoteException
      • getUniqueIdValue

        public long getUniqueIdValue()
                              throws MXException,
                                     java.rmi.RemoteException,
                                     java.lang.NullPointerException
        Gets the unique ID value for the current row. Throws NullPointerException if there isn't a current Mbo (DataBean's MboSet is empty).
        Throws:
        MXException
        java.rmi.RemoteException
        java.lang.NullPointerException
        See Also:
        psdi.mbo.getUniqueIDValue
      • getUniqueIdName

        public java.lang.String getUniqueIdName()
                                         throws MXException,
                                                java.rmi.RemoteException
        Gets the unique ID name for the current Mbo. Returns null if there isn't a current Mbo.
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        psdi.mbo.getUniqueIDName
      • smartFill

        public MboSetRemote smartFill(int row,
                                      java.lang.String attribute,
                                      java.lang.String value,
                                      boolean exactMatch)
                               throws MXException,
                                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • smartFill

        public MboSetRemote smartFill(java.lang.String attribute,
                                      java.lang.String value,
                                      boolean exactMatch)
                               throws MXException,
                                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getUniqueIdFromSmartFill

        public long getUniqueIdFromSmartFill(java.lang.String attribute,
                                             java.lang.String value)
                                      throws MXException,
                                             java.rmi.RemoteException
        Gets the uniqueid for a particular attribute who's value is a key value in a related table. Example itemnum in polines. Returns -1 if there isn't a current Mbo or value.
        Throws:
        MXException
        java.rmi.RemoteException
      • getUniqueIdFromSmartFill

        public long getUniqueIdFromSmartFill(java.lang.String applicName,
                                             java.lang.String attribute,
                                             java.lang.String value)
                                      throws MXException,
                                             java.rmi.RemoteException
        Gets the uniqueid for a particular attribute who's value is a key value in a related table. Example itemnum in polines. Returns -1 if there isn't a current Mbo or value.It takes an extra attribute appName to get the correct uniqueid for the app
        Throws:
        MXException
        java.rmi.RemoteException
      • refreshTable

        public void refreshTable()
        Refreshes the data in the table.
      • reloadTable

        public void reloadTable()
        Gets a new MboSetRemote for the DataBean. Only call this event if the data has been saved or the MboSet is obtained via a relationship from a Mbo.
      • getSmartFillValue

        public java.lang.String getSmartFillValue()
        Returns the value the user typed in that involked the smartFill.
      • setSmartFillValue

        public void setSmartFillValue(java.lang.String smartFillValue)
        Sets the value the user typed in that involked the smartFill.
      • cancelDialog

        public int cancelDialog()
                         throws MXException,
                                java.rmi.RemoteException
        Called by the dialog control when the dialog is cancled. Override this method if any special processing needs to be done when the user closes a dialog.
        Throws:
        MXException
        java.rmi.RemoteException
      • checkESigAuthenticated

        public void checkESigAuthenticated(java.lang.String option)
                                    throws MXException,
                                           java.rmi.RemoteException
        Checks if the esignature authentication dialog needs to be opened based on option If the option does need authentication, it will throw an ESigLoginException
        Parameters:
        option - Option to check
        Throws:
        MXException - EsigLoginException if authentication is required
        java.rmi.RemoteException
      • setEsigValidated

        public void setEsigValidated(boolean validated)
        Set the eSignature valideted flag
      • getDescAttributeId

        public java.lang.String getDescAttributeId()
        Returns description attribute Id
      • setDescAttributeId

        public void setDescAttributeId(java.lang.String string)
        Sets description attribute Id
      • setPageRowCount

        public void setPageRowCount(int rowCount)
      • _useAllRecsQuery

        public int _useAllRecsQuery()
                             throws MXException,
                                    java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • useAllRecsQuery

        public int useAllRecsQuery()
                            throws MXException,
                                   java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • _useAllBookmarksQuery

        public int _useAllBookmarksQuery()
                                  throws MXException,
                                         java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • useAllBookmarksQuery

        public int useAllBookmarksQuery()
                                 throws MXException,
                                        java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • _usequery

        public int _usequery()
                      throws MXException,
                             java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • usequery

        public int usequery()
                     throws MXException,
                            java.rmi.RemoteException
        Handler for setting a query - the query name is in the event value
        Throws:
        MXException
        java.rmi.RemoteException
      • useQuery

        public void useQuery(java.lang.String queryName)
                      throws MXException,
                             java.rmi.RemoteException
        Uses the stored query as the user defined query that overrides the QBE.
        Throws:
        MXException
        java.rmi.RemoteException
      • sqlwhere

        public int sqlwhere()
                     throws MXException,
                            java.rmi.RemoteException
        Handler for setting a query - the query name is in the event value
        Throws:
        MXException
        java.rmi.RemoteException
      • useqbe

        public int useqbe()
                   throws MXException,
                          java.rmi.RemoteException
        Handler for setting a qbe set
        Throws:
        MXException
        java.rmi.RemoteException
      • queryAllRecs

        public void queryAllRecs()
                          throws MXException,
                                 java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • queryAllBookmarks

        public void queryAllBookmarks()
                               throws MXException,
                                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getCurrentQueryName

        public java.lang.String getCurrentQueryName()
      • clearBean

        public void clearBean()
                       throws MXException,
                              java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • setCurrentQueryName

        protected void setCurrentQueryName(java.lang.String queryName)
      • setQueryBySiteQbe

        public void setQueryBySiteQbe()
                               throws MXException,
                                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getWorkflowDirections

        protected void getWorkflowDirections(WorkflowDirector director)
                                      throws MXException
        Checks the workflow director for the next thing to do.
        Parameters:
        director - The current workflow director object.
        Throws:
        MXException
      • moveToMboFromDataBean

        public boolean moveToMboFromDataBean(DataBean dataBean,
                                             java.lang.String dataAttribute)
                                      throws MXException,
                                             java.rmi.RemoteException
        Uses smartFindByObjectName to get the uniqueid of the value from the passed in databean and then moves this databean's currentPosition to the mbo with that uniqueid.
        Throws:
        MXException
        java.rmi.RemoteException
      • reserveOnePair

        protected void reserveOnePair(java.lang.String key,
                                      java.lang.Object value)
      • hierarchicalmove

        public int hierarchicalmove()
                             throws MXException,
                                    java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getTableOffset

        public int getTableOffset()
      • getSortOrder

        public java.lang.String getSortOrder(java.lang.String sortAttribute)
      • addSigOption

        public void addSigOption(java.lang.String sigoption)
        Add a sigoption to the databean to be used for conditonal UI. This will be added to a list of sigoptions that will be used to fetch the conditonal properties.
        Parameters:
        sigoption - The sigoption name that will be used to get conditional properties for a control bound to the databean
      • addConditionalProperties

        public void addConditionalProperties(java.lang.String sigOption,
                                             int row,
                                             java.util.HashMap properties)
        Adds the passed in conditional properties to the conditional properties cache of the DataBean
        Parameters:
        sigOption - the sigoption associated witht he conditional properties
        row - mbo index for which these conditional properies came from
        properties - the map of name value pairs of conditional properties
      • getConditionalProperties

        public java.util.HashMap getConditionalProperties(int row,
                                                          java.lang.String sigOption)
                                                   throws MXException,
                                                          java.rmi.RemoteException
        Returns a HashMap of conditional properties if the condition results for the sigoption have changed since the last time the conditions were evaluated on the mbo of the given row. The method will return null if the results are the same.
        Parameters:
        row - the mbo to check
        sigOption - the sigoption to get the condition properties for.
        Throws:
        MXException
        java.rmi.RemoteException
      • hasSigOptionAccess

        public boolean hasSigOptionAccess(java.lang.String sigOption)
                                   throws java.rmi.RemoteException,
                                          MXException
        Returns true if the user has record level privileges for a given sigoption on the current mbo.
        Parameters:
        sigOption - The sigoption that will be checked to see if the user has privileges for it, for the given Mbo.
        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 mbo doesn't exist, false it returned. (Changed in 7.1.1.5-BS. Prior versions checked on the app level, which almost always returned true)
        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.
        Throws:
        java.rmi.RemoteException
        MXException
      • getMboSetFromSmartFind

        public MboSetRemote getMboSetFromSmartFind(int row,
                                                   java.lang.String attribute)
                                            throws MXException,
                                                   java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboSetFromSmartFind

        public MboSetRemote getMboSetFromSmartFind(java.lang.String attribute)
                                            throws MXException,
                                                   java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboSetFromSmartFind

        public MboSetRemote getMboSetFromSmartFind(java.lang.String app,
                                                   java.lang.String attribute)
                                            throws MXException,
                                                   java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • canFetchData

        public boolean canFetchData()
        Returns the fetchData flag, which if false prevents the DataBean from fetching data until user interaction forces the fetch (like filtering)
      • getRemoteForDownload

        public MboSetRemote getRemoteForDownload()
                                          throws java.rmi.RemoteException,
                                                 MXException
        Returns a discardable MboSetRemote used for table downloading of data to excel. If a discardable MboSetRemote cannot be used then the beans MboSetRemote is used.
        Throws:
        java.rmi.RemoteException
        MXException
      • isSubSelect

        public boolean isSubSelect()
        Is the table for this bean in multi-select mode
      • setDynamicAppDefaults

        public void setDynamicAppDefaults(MboRemote mbo)
        Set dynamice default values on the passed in mbo. Assumes the mbo has just been inserted. The dynamic values were set a call to setDynamicAppDefaults.
      • setDynamicDefault

        public void setDynamicDefault(java.lang.String attribute,
                                      DataBean frmDataBean,
                                      java.lang.String frmAttribute,
                                      java.lang.String defaultType)
        Sets a dynamic default value on inserted mbos. The defaulted vaule will come from the passed in attribute of the current mbo in the passed in databean.
      • setDynamicQbeDefaults

        public void setDynamicQbeDefaults()
        calls setQbe for all default qbes.
      • changeRequiredField

        public boolean changeRequiredField(int row,
                                           java.lang.String attribute,
                                           boolean required)
        Changes the required flag for the mbo of give row, for the specified attribute. Returns true if the flag was changed, false if it wasn't.
      • getQueryNameBeforeReviseAction

        public java.lang.String getQueryNameBeforeReviseAction()
      • setQueryNameBeforeReviseAction

        public void setQueryNameBeforeReviseAction(java.lang.String queryName)
      • getQueryDescBeforeReviseAction

        public java.lang.String getQueryDescBeforeReviseAction()
      • setQueryDescBeforeReviseAction

        public void setQueryDescBeforeReviseAction(java.lang.String queryDesc)
      • setEmptyOnClear

        public void setEmptyOnClear(boolean emptyOnClear)
        Sets the emptyOnClear flag that if true, when clearing the filter of a table, prevent the DataBean from fetching data. (So the table is empty.)
      • asyncLocked

        public boolean asyncLocked()
        Is the bean being used by the AsyncProcess
      • setAsyncLock

        public void setAsyncLock(boolean asyncLock)
        Set whether or not the long op query AsyncProcess is envoking a method on this bean. true AsyncProcess is using it, false it is done with it.
      • madeRequiredConditionally

        public boolean madeRequiredConditionally(java.lang.String attribute)
      • isListTableModified

        public boolean isListTableModified()
        Check to see if the records have modifications or deletes. This is used only when Retain List Tab state is enabled
      • setListTableModified

        public void setListTableModified(boolean inChange)
        Flags the listable has been modified or records deleted. Used in conjuction with Retain List Tabale state.
      • isListTableRetain

        public boolean isListTableRetain()
        Check if it is resultsbean in a list and the Retain List Table functionality is enabled via system configuration.
      • setListTableRetain

        public void setListTableRetain(boolean inRetain)
        Flag is enabled only if it is resultsbean in a list and the Retain List Table functionality is enabled via system configuration.
      • getCurrentQueryDescription

        public java.lang.String getCurrentQueryDescription()
      • setCurrentQueryDescription

        public void setCurrentQueryDescription(java.lang.String queryDescription)
      • boundToTable

        public boolean boundToTable()
        Returns true if the DataBean has controls within a table bound to it.
        Returns:
        Returns true if a the databean is used by a table's columns.
      • setApplicationError

        public void setApplicationError(java.lang.String dataAttribute,
                                        int row,
                                        ApplicationError error)
                                 throws MXException
        Sets the Application error on the mbo of the passed in index
        Throws:
        MXException
      • buildPortalMsg

        public java.lang.String buildPortalMsg(java.lang.String attribute,
                                               java.lang.String newValue)
        Builds the message to be sent to other portlets. This method should be written at the appbean level to hook into CommonDataModel or whatever other format the data should be transmitted in. When the application's appBean overrides this method, they should return the string in the format: return attribute+":"+newValue;
      • rePosition

        public boolean rePosition()
                           throws java.rmi.RemoteException,
                                  MXException
        This method is required to reposition of the databean to the retained postion. This is required for reposition the databean on a save after change return if method is succesful
        Throws:
        java.rmi.RemoteException
        MXException
      • isAppTableRetain

        public boolean isAppTableRetain()
        Returne true if the retain table state flag is set and the current databean is turned on to retain position
      • positionState

        public void positionState()
        Tracks if the save has happened and the bean is marked to position the data
      • markTablePosition

        public void markTablePosition(boolean inFlg)
        Set the flag if mbo has changes and we have to retain the position If the parent bean which is bound to a table then set it to postion also.
      • isTablePostionMarked

        public boolean isTablePostionMarked()
        Checks if the table has to retain position.
        Returns:
        if marked for retaining
      • getUIERMEntity

        public UIERMEntity getUIERMEntity()
        Returns:
        the ermEntity of the DataBean
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • registerDynamicControlsWithERM

        public void registerDynamicControlsWithERM(java.util.List controls)
                                            throws java.rmi.RemoteException,
                                                   MXException
        Throws:
        java.rmi.RemoteException
        MXException
      • getLockedByDisplayName

        public java.lang.String getLockedByDisplayName(int row)
                                                throws MXException,
                                                       java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • isRowLocked

        public boolean isRowLocked(int row)
                            throws MXException,
                                   java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • isLookupMultiSelect

        public boolean isLookupMultiSelect(BoundComponentInstance boundComponentInstance,
                                           boolean isQueryInput)
        Override this method in individual beans if other application-specific factors need to be considered in addition to whether or not the control is query-based to determine if a lookup is MultiSelect or not.
        Parameters:
        boundComponentInstance -
        isQueryInput -
      • getSavedFilterSettings

        public java.util.Hashtable getSavedFilterSettings()
      • getParentRelationship

        public java.lang.String getParentRelationship()