psdi.mbo

Interface MboSetRemote

    • Field Detail

      • INSERTONLY

        static final int INSERTONLY
        Option INSERTONLY used by locateMbo() method.
        See Also:
        Constant Field Values
      • UPDATEONLY

        static final int UPDATEONLY
        Option UPDATEONLY used by locateMbo() method.
        See Also:
        Constant Field Values
      • INSERTORUPDATE

        static final int INSERTORUPDATE
        Option INSERTORUPDATE used by locateMbo() method.
        See Also:
        Constant Field Values
    • Method Detail

      • findKey

        MboRemote findKey(java.lang.Object keyObject)
                   throws MXException,
                          java.rmi.RemoteException
        Reset the MboSet to the Mbo that contains the specified key. Callers can pass in either a string containing the key, or an array of strings for multipart keys. The isEmpty() call can be used to see if the resulting MboSet contained the key.
        Throws:
        MXException
        java.rmi.RemoteException
      • setApp

        void setApp(java.lang.String appName)
             throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
        See Also:
        MboSet.setApp(String appName)
      • getApp

        java.lang.String getApp()
                         throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getWhere

        java.lang.String getWhere()
                           throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getUserWhere

        java.lang.String getUserWhere()
                               throws MXException,
                                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getUserAndQbeWhere

        java.lang.String getUserAndQbeWhere()
                                     throws MXException,
                                            java.rmi.RemoteException
        Returns the combined user where and QBE where clause in native SQL format.
        Throws:
        MXException
        java.rmi.RemoteException
      • getQbeWhere

        java.lang.String getQbeWhere()
                              throws MXException,
                                     java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • setDefaultOrderBy

        void setDefaultOrderBy()
                        throws MXException,
                               java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getOrderBy

        java.lang.String getOrderBy()
                             throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getSQLOptions

        java.lang.String getSQLOptions()
                                throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • addAtIndex

        MboRemote addAtIndex(long accessModifier,
                             int index)
                      throws MXException,
                             java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        psdi.mbo.MboSet#addAtIndex(int, long)
      • getSize

        int getSize()
             throws java.rmi.RemoteException
        Returns:
        Throws:
        java.rmi.RemoteException
        See Also:
        MboSet.getSize()
      • latestDate

        java.util.Date latestDate(java.lang.String attributeName)
                           throws MXException,
                                  java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • earliestDate

        java.util.Date earliestDate(java.lang.String attributeName)
                             throws MXException,
                                    java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • save

        void save(long flag)
           throws MXException,
                  java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • close

        void close()
            throws MXException,
                   java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getCurrentPosition

        int getCurrentPosition()
                        throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • toBeSaved

        boolean toBeSaved()
                   throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getMboSetData

        MboSetData getMboSetData(int row,
                                 int count,
                                 java.lang.String[] attributes)
                          throws MXException,
                                 java.rmi.RemoteException
        Return information about the MboSet and the specified attributes for the specified rows.
        Throws:
        MXException
        java.rmi.RemoteException
      • resetQbe

        void resetQbe()
               throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
        See Also:
        MboSet.resetQbe()
      • getQbe

        java.lang.String getQbe(java.lang.String attribute)
                         throws MXException,
                                java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getQbe

        java.lang.String[] getQbe(java.lang.String[] attribute)
                           throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getQbe

        java.lang.String[][] getQbe()
                             throws MXException,
                                    java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • hasQbe

        boolean hasQbe()
                throws MXException,
                       java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • setQbeExactMatch

        void setQbeExactMatch(boolean state)
                       throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
        See Also:
        MboSet.setQbeExactMatch(boolean)
      • setQbeExactMatch

        void setQbeExactMatch(java.lang.String state)
                       throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • isQbeExactMatch

        boolean isQbeExactMatch()
                         throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • isQbeCaseSensitive

        boolean isQbeCaseSensitive()
                            throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • setQbeCaseSensitive

        void setQbeCaseSensitive(java.lang.String state)
                          throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getName

        java.lang.String getName()
                          throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getWarnings

        MXException[] getWarnings()
                           throws java.rmi.RemoteException
        Returns a list of warnings from the last method call. Warnings are MXExceptions that do not cause a method to fail. They can be used as information about assumptions or defaults that were used when a method was executing. Note that it is possible that warnings may be available for a method that generated warnings, even if it was NOT the last method called. For example, method A generates warnings, but method B does not, If B was the last method called, and a call to getWarnings() is then made, the warnings from method A will be returned. It should be docuemented in the JAVADOC comments for a method if warnings are generated. A call to the getWarnings() method clears the warning list.
        Throws:
        java.rmi.RemoteException
        See Also:
        MboSetRemote.hasWarnings(), MboSet.clearWarnings(), MboSet.addWarning(psdi.util.MXException)
      • hasWarnings

        boolean hasWarnings()
                     throws java.rmi.RemoteException
        Are there any warnings.
        Throws:
        java.rmi.RemoteException
      • addWarnings

        void addWarnings(MXException[] es)
                  throws java.rmi.RemoteException
        Add all the exceptions from an array to the warning vector
        Parameters:
        es - An array of MXExceptions. It is normally obtained from getWarnings().
        Throws:
        java.rmi.RemoteException
      • addWarning

        void addWarning(MXException e)
                 throws java.rmi.RemoteException
        Add a warning to the warning list
        Throws:
        java.rmi.RemoteException
      • checkMethodAccess

        void checkMethodAccess(java.lang.String methodName)
                        throws MXException,
                               java.rmi.RemoteException
        Clear the warnings
        Throws:
        java.rmi.RemoteException
        MXException
      • validate

        void validate()
               throws MXException,
                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • commit

        void commit()
             throws MXException,
                    java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • rollback

        void rollback()
               throws MXException,
                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • deleteAll

        void deleteAll(long accessModifier)
                throws MXException,
                       java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • setRelationship

        void setRelationship(java.lang.String whereClause)
                      throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getRelationship

        java.lang.String getRelationship()
                                  throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • setMboSetInfo

        void setMboSetInfo(MboSetInfo ms)
                    throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • setFlag

        void setFlag(long flag,
                     boolean state)
              throws MXException,
                     java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • setFlag

        void setFlag(long flag,
                     boolean state,
                     MXException mxException)
              throws MXException,
                     java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • isFlagSet

        boolean isFlagSet(long flag)
                   throws MXException,
                          java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getFlags

        long getFlags()
               throws MXException,
                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getUserName

        java.lang.String getUserName()
                              throws MXException,
                                     java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • copy

        void copy(MboSetRemote sourceSet,
                  java.lang.String[] srcAttributes,
                  java.lang.String[] destAttributes)
           throws MXException,
                  java.rmi.RemoteException
        New Mbos are created in this set from the sourceSet and appropriate attribute values are copied to the mbos.
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboSetInfo

        MboSetInfo getMboSetInfo()
                          throws java.rmi.RemoteException
        Return information about the attributes in the MboSet.
        Throws:
        java.rmi.RemoteException
      • getKeyAttributes

        java.lang.String[] getKeyAttributes()
                                     throws java.rmi.RemoteException
        Returns list of key attributes.
        Throws:
        java.rmi.RemoteException
      • setMXTransaction

        void setMXTransaction(MXTransaction txn)
                       throws java.rmi.RemoteException
        Set the transaction information for the object
        Throws:
        java.rmi.RemoteException
      • getMXTransaction

        MXTransaction getMXTransaction()
                                throws java.rmi.RemoteException
        Get the currently active transaction for this object. If there is no current transaction, a new one is created for you.
        Throws:
        java.rmi.RemoteException
      • getCompleteWhere

        java.lang.String getCompleteWhere()
                                   throws MXException,
                                          java.rmi.RemoteException
        Get the complete Where clause that is used for fetching records to this object. This includes Qbe, setWhere() method calls and application restrictions.
        Throws:
        MXException
        java.rmi.RemoteException
      • remove

        void remove(int pos)
             throws MXException,
                    java.rmi.RemoteException
        Remove an object from the collection at the given position. This does not remove the object from the database, in order to remove the object from the database, use delete method.
        Throws:
        MXException
        java.rmi.RemoteException
      • remove

        void remove()
             throws MXException,
                    java.rmi.RemoteException
        Remove the current object from the collection. This does not remove the object from the database, in order to remove the object from the database, use delete method.
        Throws:
        MXException
        java.rmi.RemoteException
      • remove

        void remove(MboRemote mbo)
             throws MXException,
                    java.rmi.RemoteException
        Removes a mbo object from the collection. This does not remove the object from the database, in order to remove the object from the database, use delete method.
        Throws:
        MXException
        java.rmi.RemoteException
      • deleteAndRemove

        void deleteAndRemove(int pos)
                      throws MXException,
                             java.rmi.RemoteException
        Deletes and remove an object from the collection at the given position, if the mbo at the position is a newly created.
        Throws:
        MXException
        java.rmi.RemoteException
      • deleteAndRemove

        void deleteAndRemove(int pos,
                             long accessModifier)
                      throws MXException,
                             java.rmi.RemoteException
        Deletes and remove an object from the collection at the given position, if the mbo at the position is a newly created.
        Throws:
        MXException
        java.rmi.RemoteException
      • deleteAndRemove

        void deleteAndRemove()
                      throws MXException,
                             java.rmi.RemoteException
        Deletes and Removes the current mbo from the collection, if the mbo is newly created .
        Throws:
        MXException
        java.rmi.RemoteException
      • deleteAndRemove

        void deleteAndRemove(MboRemote mbo)
                      throws MXException,
                             java.rmi.RemoteException
        Delets and removes a mbo object from the collection, if the mbo is newly created .
        Throws:
        MXException
        java.rmi.RemoteException
      • deleteAndRemove

        void deleteAndRemove(MboRemote mbo,
                             long accessModifier)
                      throws MXException,
                             java.rmi.RemoteException
        Delets and removes a mbo object from the collection, if the mbo is newly created .
        Throws:
        MXException
        java.rmi.RemoteException
      • deleteAndRemoveAll

        void deleteAndRemoveAll()
                         throws MXException,
                                java.rmi.RemoteException
        Deletes and removes all the newly created Mbos from the collection. This method is designed to be called to make the newly added mbos removed from the collection, thus won't be displayed on the GUI at all, but the deleting logic of these mbos are still being executed. This method is intended to be called only when there are no saved mbos in the mboset. However, if there are saved mbos, the state of those mbos are not affected. If a user wants to have those saved mbos further deleted or removed, deleteAll() or clear() can be called after this method is called on this Mbo set.
        Throws:
        MXException
        java.rmi.RemoteException
      • deleteAndRemoveAll

        void deleteAndRemoveAll(long accessModifier)
                         throws MXException,
                                java.rmi.RemoteException
        Deletes and removes all the newly created Mbos from the collection. This method is designed to be called to make the newly added mbos removed from the collection, thus won't be displayed on the GUI at all, but the deleting logic of these mbos are still being executed. This method is intended to be called only when there are no saved mbos in the mboset. However, if there are saved mbos, the state of those mbos are not affected. If a user wants to have those saved mbos further deleted or removed, deleteAll() or clear() can be called after this method is called on this Mbo set.
        Throws:
        MXException
        java.rmi.RemoteException
      • clear

        void clear()
            throws MXException,
                   java.rmi.RemoteException
        Remove all objects from the collection. This does not remove the object from the database, in order to remove the object from the database, use delete method.
        Throws:
        MXException
        java.rmi.RemoteException
      • incrementDeletedCount

        void incrementDeletedCount(boolean inc)
                            throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getUserInfo

        UserInfo getUserInfo()
                      throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • getZombie

        MboRemote getZombie()
                     throws java.rmi.RemoteException
        Internal method. Should not be called.
        Throws:
        java.rmi.RemoteException
      • cleanup

        void cleanup()
              throws MXException,
                     java.rmi.RemoteException
        Resets the Qbe and the set. This also closes the cursor.
        Throws:
        MXException
        java.rmi.RemoteException
      • startCheckpoint

        void startCheckpoint()
                      throws MXException,
                             java.rmi.RemoteException
        Save the current value for later rollback.
        Throws:
        MXException
        java.rmi.RemoteException
      • rollbackToCheckpoint

        void rollbackToCheckpoint()
                           throws MXException,
                                  java.rmi.RemoteException
        Reverts to the saved value. To save the value, use startCheckpoint.
        Throws:
        MXException
        java.rmi.RemoteException
      • startCheckpoint

        void startCheckpoint(int i)
                      throws MXException,
                             java.rmi.RemoteException
        Save the current value for later rollback for the given mbo.
        Throws:
        MXException
        java.rmi.RemoteException
      • rollbackToCheckpoint

        void rollbackToCheckpoint(int i)
                           throws MXException,
                                  java.rmi.RemoteException
        Reverts to the saved value for the given mbo. To save the value, use startCheckpoint.
        Throws:
        MXException
        java.rmi.RemoteException
      • select

        void select(int index)
             throws MXException,
                    java.rmi.RemoteException
        Marks the Mbo at the specified index Selected.
        Throws:
        MXException
        java.rmi.RemoteException
      • select

        void select(int startIndex,
                    int count)
             throws MXException,
                    java.rmi.RemoteException
        Marks the a set of Mbos starting from startIndex Selected.
        Throws:
        MXException
        java.rmi.RemoteException
      • select

        void select(java.util.Vector mboIndices)
             throws MXException,
                    java.rmi.RemoteException
        Marks a set of Mbo's Selected in one call by taking all the indices of mbos.
        Throws:
        MXException
        java.rmi.RemoteException
      • unselect

        void unselect(int index)
               throws MXException,
                      java.rmi.RemoteException
        Marks the Mbo at the specified index Unselected.
        Throws:
        MXException
        java.rmi.RemoteException
      • unselect

        void unselect(int startIndex,
                      int count)
               throws MXException,
                      java.rmi.RemoteException
        Marks the a set of Mbos starting from startIndex Unselected.
        Throws:
        MXException
        java.rmi.RemoteException
      • unselect

        void unselect(java.util.Vector mboIndices)
               throws MXException,
                      java.rmi.RemoteException
        Marks a set of Mbo's Unselected in one call by taking all the indices of mbos.
        Throws:
        MXException
        java.rmi.RemoteException
      • getSelection

        java.util.Vector getSelection()
                               throws MXException,
                                      java.rmi.RemoteException
        Returns a Vector of selected mbos.
        Throws:
        MXException
        java.rmi.RemoteException
      • selectAll

        void selectAll()
                throws MXException,
                       java.rmi.RemoteException
        Select all Mbos
        Throws:
        MXException
        java.rmi.RemoteException
      • unselectAll

        void unselectAll()
                  throws MXException,
                         java.rmi.RemoteException
        Unselect all mbos
        Throws:
        MXException
        java.rmi.RemoteException
      • resetWithSelection

        void resetWithSelection()
                         throws MXException,
                                java.rmi.RemoteException
        Resets the MboSet to contain only the selected mbos.
        Throws:
        MXException
        java.rmi.RemoteException
      • getAppWhere

        java.lang.String getAppWhere()
                              throws MXException,
                                     java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        psdi.mbo.MboSet#getAppWhere(String)
      • getSelectionWhere

        java.lang.String getSelectionWhere()
                                    throws MXException,
                                           java.rmi.RemoteException
        Returns the where clause for the selected Mbos.
        Throws:
        MXException
        java.rmi.RemoteException
      • setDefaultValue

        void setDefaultValue(java.lang.String attribute,
                             java.lang.String value)
                      throws MXException,
                             java.rmi.RemoteException
        set the default value for mboset(screen default)
        Throws:
        MXException
        java.rmi.RemoteException
      • getDefaultValue

        java.lang.String getDefaultValue(java.lang.String attribute)
                                  throws MXException,
                                         java.rmi.RemoteException
        get the default value for mboset(screen default)
        Throws:
        MXException
        java.rmi.RemoteException
      • setDefaultValues

        void setDefaultValues(java.lang.String[] attributes,
                              java.lang.String[] values)
                       throws MXException,
                              java.rmi.RemoteException
        set the default Field value for mboset(jsp default)
        Throws:
        MXException
        java.rmi.RemoteException
      • isESigNeeded

        boolean isESigNeeded(java.lang.String optionName)
                      throws MXException,
                             java.rmi.RemoteException
        Returns whether esig is needed for the given option name.
        Throws:
        MXException
        java.rmi.RemoteException
      • verifyESig

        boolean verifyESig(java.lang.String username,
                           java.lang.String password,
                           java.lang.String reason)
                    throws MXException,
                           java.rmi.RemoteException
        Verifies the username and password and if they are correct, then writes out an esig record.
        Throws:
        MXException
        java.rmi.RemoteException
      • logESigVerification

        void logESigVerification(java.lang.String username,
                                 java.lang.String reason,
                                 boolean authenticatedSuccessfully)
                          throws MXException,
                                 java.rmi.RemoteException
        Logs a esig record aboout the user indicating the reason for the verification and whether the user authentication is successful or not.
        Throws:
        MXException
        java.rmi.RemoteException
      • getESigTransactionId

        java.lang.String getESigTransactionId()
                                       throws MXException,
                                              java.rmi.RemoteException
        Gets the esig transaction id
        Throws:
        MXException
        java.rmi.RemoteException
      • setLastESigTransId

        void setLastESigTransId(java.lang.String id)
                         throws MXException,
                                java.rmi.RemoteException
        Sets the last esig trans id
        Throws:
        MXException
        java.rmi.RemoteException
      • setESigFieldModified

        void setESigFieldModified(boolean esigFieldModified)
                           throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • setTableDomainLookup

        void setTableDomainLookup(boolean flag)
                           throws java.rmi.RemoteException
        Sets the tableDomainLookup flag to indicate that the this set is associated with a table domain lookup. The flag is used to enforce group / site restriction.
        Throws:
        java.rmi.RemoteException
      • isBasedOn

        boolean isBasedOn(java.lang.String objectName)
                   throws java.rmi.RemoteException
        Returns true, if this business object is based on the given business object name.
        Parameters:
        objectName -
        Returns:
        if the mboSet is based on the object name or not.
        Throws:
        java.rmi.RemoteException
      • setAutoKeyFlag

        boolean setAutoKeyFlag(boolean flag)
                        throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
        See Also:
        MboSet.setAutoKeyFlag(boolean)
      • findByIntegrationKey

        MboRemote findByIntegrationKey(java.lang.String[] integrationKeys,
                                       java.lang.String[] integrationKeyValues)
                                throws MXException,
                                       java.rmi.RemoteException
        This method is used by the integration logic to find out the mbos that are present based on an integration key. This method will load all the existing records of this set into memory once when this method is called first time (this is needed to avoid multiple database calls to find each record). Also, the data that this method is going to operate is based on what's fetched from the database. Note: This method is going to fetch all the records from the database and should be used only where appropriate. The code assumes that the key values are passed in the same order as the default integration key order based on the getDefaultIntegrationKeyAttributes() method in the MboSetInfo.
        Parameters:
        integrationKeys - list of key attributes
        integrationKeyValues - list of key values
        Returns:
        MboRemote a reference to the mbo, if found, otherwise null.
        Throws:
        MXException
        java.rmi.RemoteException
      • setRelationName

        void setRelationName(java.lang.String relationName)
                      throws MXException,
                             java.rmi.RemoteException
        This method sets the relationship name used to created this set when this set is obtained from a mbo. Please note that this is an internal method and should not be called by any other code.
        Parameters:
        relationName - relationship name
        Throws:
        MXException
        java.rmi.RemoteException
      • getRelationName

        java.lang.String getRelationName()
                                  throws MXException,
                                         java.rmi.RemoteException
        Returns the relationship name used to obtain this set. If this set is not obtained through a relationship, returns null.
        Returns:
        String the relation name, if this set is obtained through a relationship, otherwise null.
        Throws:
        MXException
        java.rmi.RemoteException
      • getMLFromClause

        java.lang.StringBuffer getMLFromClause(boolean useSchemaOwner)
                                        throws MXException,
                                               java.rmi.RemoteException
        Returns the join from clause.
        Parameters:
        useSchemaOwner -
        Returns:
        Throws:
        MXException
        java.rmi.RemoteException
      • hasMLQbe

        boolean hasMLQbe()
                  throws MXException,
                         java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboForUniqueId

        MboRemote getMboForUniqueId(long id)
                             throws MXException,
                                    java.rmi.RemoteException
        returns the mbo for the unique id
        Returns:
        MboRemote
        Throws:
        MXException
        java.rmi.RemoteException
      • getMessage

        java.lang.String getMessage(java.lang.String errGrp,
                                    java.lang.String errKey)
                             throws java.rmi.RemoteException
        Get the message in the language specified by this MboSet's userInfo for the error group and error key. If no such message is found, errGrp#errKey will be returned.
        Parameters:
        errGrp -
        errKey -
        Returns:
        Throws:
        java.rmi.RemoteException
      • getMessage

        java.lang.String getMessage(java.lang.String errGrp,
                                    java.lang.String errKey,
                                    java.lang.Object[] params)
                             throws java.rmi.RemoteException
        Parameters:
        errGrp -
        errKey -
        params -
        Returns:
        Throws:
        java.rmi.RemoteException
        See Also:
        Mbo.getMessage(String errGrp, String errKey, Object[] params)
      • getMessage

        java.lang.String getMessage(java.lang.String errGrp,
                                    java.lang.String errKey,
                                    java.lang.Object param)
                             throws java.rmi.RemoteException
        Parameters:
        errGrp -
        errKey -
        params -
        Returns:
        Throws:
        java.rmi.RemoteException
        See Also:
        Mbo.getMessage(String errGrp, String errKey, Object param)
      • getMessage

        java.lang.String getMessage(MXException exception)
                             throws java.rmi.RemoteException
        Get the message of the exception in the language specified by this MboSet's userInfo. returned.
        Parameters:
        errGrp -
        errKey -
        Returns:
        Throws:
        java.rmi.RemoteException
      • getMaxMessage

        MaxMessage getMaxMessage(java.lang.String errGrp,
                                 java.lang.String errKey)
                          throws MXException,
                                 java.rmi.RemoteException
        Get the MaxMessage object for the specified error group and errorkey.
        Parameters:
        errGrp -
        errKey -
        Returns:
        Throws:
        MXException
        java.rmi.RemoteException
      • setQueryBySiteQbe

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

        boolean setLogLargFetchResultDisabled(boolean disable)
                                       throws java.rmi.RemoteException
        Pass true to disable loging of large fetch result set over a limit. The method returns the existing value of the flag.
        Parameters:
        disable -
        Returns:
        Throws:
        java.rmi.RemoteException
      • setWhereQbe

        void setWhereQbe(java.lang.String attribute,
                         java.lang.String value,
                         java.lang.String where)
                  throws MXException,
                         java.rmi.RemoteException
        Sets the where clause for the QBE
        Parameters:
        attribute -
        value -
        where -
        Throws:
        MXException
        java.rmi.RemoteException
      • ignoreQbeExactMatchSet

        void ignoreQbeExactMatchSet(boolean flag)
                             throws MXException,
                                    java.rmi.RemoteException
        ignore the exact match set by setQbeExactMatch(boolean) method
        Throws:
        java.rmi.RemoteException
        MXException
      • setExcludeMeFromPropagation

        void setExcludeMeFromPropagation(boolean flag)
                                  throws MXException,
                                         java.rmi.RemoteException
        Sets the flag to excude a mboset from propagation
        Parameters:
        flag -
        Throws:
        MXException
        java.rmi.RemoteException
      • getExcludeMeFromPropagation

        boolean getExcludeMeFromPropagation()
                                     throws MXException,
                                            java.rmi.RemoteException
        Gets the flag to excude a mboset from propagation
        Parameters:
        flag -
        Throws:
        MXException
        java.rmi.RemoteException
      • setInsertSite

        void setInsertSite(java.lang.String site)
                    throws MXException,
                           java.rmi.RemoteException
        Sets the insert site for the mboset. This method shouldn't be used for UI. It should only be used for MEA. If this is set mbo takes insertSiteForSet instead of profile
        Parameters:
        site -
        Throws:
        MXException
        java.rmi.RemoteException
      • setInsertOrg

        void setInsertOrg(java.lang.String org)
                   throws MXException,
                          java.rmi.RemoteException
        Sets the insert org for the mboset. This method shouldn't be used for UI. It should only be used for MEA. If this is set mbo takes insertOrgForSet instead of profile
        Parameters:
        site -
        Throws:
        MXException
        java.rmi.RemoteException
      • setInsertCompanySet

        void setInsertCompanySet(java.lang.String compSet)
                          throws MXException,
                                 java.rmi.RemoteException
        Sets the insert company set for the mboset. This method shouldn't be used for UI. It should only be used for MEA. If this is set mbo takes insertCompanysetForSet instead of profile
        Parameters:
        site -
        Throws:
        MXException
        java.rmi.RemoteException
      • setInsertItemSet

        void setInsertItemSet(java.lang.String itemSet)
                       throws MXException,
                              java.rmi.RemoteException
        Sets the insert item set for the mboset. This method shouldn't be used for UI. It should only be used for MEA. If this is set mbo takes insertItemsetForSet instead of profile
        Parameters:
        site -
        Throws:
        MXException
        java.rmi.RemoteException
      • processML

        boolean processML()
                   throws MXException,
                          java.rmi.RemoteException
        Whether multi-language needs to be considered
        Throws:
        MXException
        java.rmi.RemoteException
      • locateMbo

        MboRemote locateMbo(java.lang.String[] key,
                            java.lang.String[] value,
                            int option)
                     throws MXException,
                            java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        psdi.mbo.MboSet#locateMbo()
      • setDMDeploySet

        void setDMDeploySet(boolean flag)
                     throws MXException,
                            java.rmi.RemoteException
        Mark the set as created during deploy action of Deployment Manager. If the flag is set to true,it will skip mbo.validate method which will skip all field validations and appvalidate.
        Parameters:
        true - or false
        Throws:
        MXException
        java.rmi.RemoteException
      • isDMDeploySet

        boolean isDMDeploySet()
                       throws MXException,
                              java.rmi.RemoteException
        Returns the flag if mboset is created during Deploy action of Deployement Manager set or not If the flag is set to true,it will skip mbo.validate method which will skip all field validations and appvalidate.
        Returns:
        true if mboset is created during Deploy action of Deployement Manager set else false
        Throws:
        MXException
        java.rmi.RemoteException
      • setQbeOperatorOr

        void setQbeOperatorOr()
                       throws MXException,
                              java.rmi.RemoteException
        Set the qbe operator OR
        Throws:
        MXException
        java.rmi.RemoteException
      • setupLongOpPipe

        java.io.InputStream setupLongOpPipe()
                                     throws MXException,
                                            java.rmi.RemoteException
        Setup pipe for long op messages.
        Throws:
        MXException
        java.rmi.RemoteException
      • clearLongOpPipe

        void clearLongOpPipe()
                      throws MXException,
                             java.rmi.RemoteException
        Clear the long op message pipe.
        Throws:
        MXException
        java.rmi.RemoteException
      • abortSql

        void abortSql()
               throws MXException,
                      java.rmi.RemoteException
        Abort the sql query currently in process.
        Throws:
        MXException
        java.rmi.RemoteException
      • setQbe

        void setQbe(java.lang.String attribute,
                    java.lang.String[] expression)
             throws MXException,
                    java.rmi.RemoteException
        Qbe to take array of values for an attribute.
        Parameters:
        attribute -
        expression -
        Throws:
        MXException
        java.rmi.RemoteException
      • getQueryTimeout

        int getQueryTimeout()
                     throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • setQueryTimeout

        void setQueryTimeout(int queryTimeout)
                      throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • setAppAlwaysFieldFlag

        void setAppAlwaysFieldFlag(java.lang.String attr,
                                   long flag,
                                   boolean state)
                            throws java.rmi.RemoteException
        Informs the mbo set that any mbo of this set will have the field flags set to the specified attribute. These field flags will always be set when the mbo is created or duplicated. The field flag can be set to a different value as this method specified after the mbo is created or duplicated when the flag is set directly on Mbo or MboValue for the attribute. However, this method is intended to be called only on the attributes that the specified field flag remain the same unconditionally. For the dynamic type of field flags, you should use setFieldFlag(String name, long flag, boolean state) call on the Mbo object.
        Parameters:
        attr, - attribute of this MboSet, related fields are not allowed.
        flag -
        state -
        Throws:
        java.rmi.RemoteException
      • setTxnPropertyMap

        void setTxnPropertyMap(java.util.Map map)
                        throws MXException,
                               java.rmi.RemoteException
        Sets the property map for transaction
        Parameters:
        map -
        Throws:
        MXException
        java.rmi.RemoteException
      • getTxnPropertyMap

        java.util.Map getTxnPropertyMap()
                                 throws MXException,
                                        java.rmi.RemoteException
        Gets the property map for the transaction
        Returns:
        map
        Throws:
        MXException
        java.rmi.RemoteException
      • setDMSkipFieldValidation

        void setDMSkipFieldValidation(boolean flag)
                               throws MXException,
                                      java.rmi.RemoteException
        Mark the set as created during deploy action of Deployment Manager. If the flag is set to true,it will skip all field validations but do appvalidate.
        Parameters:
        true - or false
        Throws:
        MXException
        java.rmi.RemoteException
      • isDMSkipFieldValidation

        boolean isDMSkipFieldValidation()
                                 throws MXException,
                                        java.rmi.RemoteException
        Returns the flag if set is created during deploy action of Deployment Manager. If the flag is set to true,it will skip all field validations but do appvalidate.
        Parameters:
        true - or false
        Throws:
        MXException
        java.rmi.RemoteException
      • getAppAlwaysFieldFlags

        BitFlag getAppAlwaysFieldFlags(java.lang.String attr)
                                throws java.rmi.RemoteException
        Get the bitFlag stored for the UI always flag for the attribute, null if nothing.
        Throws:
        java.rmi.RemoteException
      • determineRequiredFieldsFromERM

        java.util.List determineRequiredFieldsFromERM()
                                               throws MXException,
                                                      java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • findAllNullRequiredFields

        java.util.List findAllNullRequiredFields()
                                          throws MXException,
                                                 java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • setRequiedFlagsFromERM

        void setRequiedFlagsFromERM()
                             throws MXException,
                                    java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • isRetainMboPosition

        boolean isRetainMboPosition()
                             throws MXException,
                                    java.rmi.RemoteException
        Is the current MboSet's mbo position to be retained?
        Returns:
        true, if the position needs to be retained.
        Throws:
        MXException
        java.rmi.RemoteException
      • setRetainMboPosition

        void setRetainMboPosition(boolean retainCurrentMboPosition)
                           throws MXException,
                                  java.rmi.RemoteException
        Sets the current MboSet's mbo position to be retained after save. Note that the position is not automatically retained after save. The positionState method must be called to position the mbo as the current mbo.
        Parameters:
        retainMboPosition - true to retain position, false otherwise.
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboSetRetainMboPositionData

        MboSetRetainMboPositionData getMboSetRetainMboPositionData()
                                                            throws MXException,
                                                                   java.rmi.RemoteException
        Returns the retain mbo position data available. Note that this information would only be available for the top level MBOSet in a Business Object graph. If this is called for any MboSet in the graph hierarchy it returns null.
        Returns:
        MboSetRetainMboPositionData position information, if this is a top level MboSet and information exists, otherwise null.
        Throws:
        MXException
        java.rmi.RemoteException
      • getMboSetRetainMboPositionInfo

        MboSetRetainMboPositionInfo getMboSetRetainMboPositionInfo()
                                                            throws MXException,
                                                                   java.rmi.RemoteException
        Returns the retain mbo position info available. Note that this information would only be available for the top level MBOSet in a Business Object graph. If this is called for any MboSet in the graph hierarchy it returns null.
        Returns:
        MboSetRetainMboPositionInfo position information, if this is a top level MboSet and information exists, otherwise null.
        Throws:
        MXException
        java.rmi.RemoteException
      • positionState

        void positionState()
                    throws MXException,
                           java.rmi.RemoteException
        Positions the current mbo based on the position data cached, if the data exists.
        Throws:
        MXException
        java.rmi.RemoteException
      • setDBFetchMaxRows

        void setDBFetchMaxRows(int fetchLimit)
                        throws java.rmi.RemoteException
        Set the fetch limit for this MboSet. When the fetch limit is set to a >0 number, the database query issued for this MboSet will only fetch this many records. If an order by is used on this MboSet, the order by will only take effect within the fetch limit of the set. For example, if you set fetch limit to 500, and you have a order by of record number desc, the lagest desc may not appear in the returned 500 records. You should only set the fetch limit for the MboSet for display purpose only, not involved in business logic that needs to process all the records in the set.
        Parameters:
        fetchLimit - a possitive number. If -1 or 0, the fetch limit will be turned off.
        Throws:
        java.rmi.RemoteException
      • getDBFetchMaxRows

        int getDBFetchMaxRows()
                       throws java.rmi.RemoteException
        Returns the fetch limit that has been set on this MboSet. It will return -1 if fetch limit hasn't been set.
        Returns:
        Throws:
        java.rmi.RemoteException
      • getSetOrderByForUI

        java.lang.String getSetOrderByForUI()
                                     throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • setSetOrderByForUI

        void setSetOrderByForUI(java.lang.String orderBy)
                         throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • newMboIndex

        int newMboIndex()
                 throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
      • setDownloadSet

        void setDownloadSet(boolean isDownloadSet)
                     throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
        See Also:
        MboSet.setDownloadSet(boolean)