psdi.app.bim.product

Class BIMCommentSet

    • Method Detail

      • getMboInstance

        protected Mbo getMboInstance(MboSet ms)
                              throws MXException,
                                     java.rmi.RemoteException
        Generate a new operating BIMComment object
        Specified by:
        getMboInstance in class MboSet
        Parameters:
        ms - mboset
        Returns:
        Mbo object
        Throws:
        MXException
        java.rmi.RemoteException
      • addAtIndex

        public MboRemote addAtIndex(long accessModifier,
                                    int ind)
                             throws MXException,
                                    java.rmi.RemoteException
        Description copied from class: MboSet
        Adds a new object to the collection at the index specified. Use the SetValue() methods to set attribute values. The next time the save() method is called, this object will be saved to the database. This is the base add method, used by all the other versions. In some MboSet sub-classes, this method is overridden.
        Specified by:
        addAtIndex in interface MboSetRemote
        Overrides:
        addAtIndex in class MboSet
        Parameters:
        accessModifier - Determines whether an access check is made.
        ind - Where to add the new Mbo. Zero is the beginning, while -1 will put the Mbo at the end of the MboSet.
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        MboSet.getMboInstance(psdi.mbo.MboSet), MboSet.addMbo(Mbo), MboSet.addMbo(Mbo, int), MboSet.moveTo(int)
      • getChildren

        public MboValueData[][] getChildren(java.lang.String object,
                                            java.lang.String key,
                                            java.lang.String[] attrs,
                                            int maxRows)
                                     throws MXException,
                                            java.rmi.RemoteException
        Returns zero or more children objects in the hierarchy.
        Specified by:
        getChildren in interface HierarchicalMboSetRemote
        Parameters:
        object - - name of the object whose children are being requested.
        key - - unique id of the object whose children are being fetched.
        attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.
        maxRows - - maximum number of rows to return.
        Returns:
        MboValueData[][] - contains an array of Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.
        Throws:
        MXException
        java.rmi.RemoteException
      • getParent

        public MboValueData[] getParent(java.lang.String object,
                                        java.lang.String key,
                                        java.lang.String[] attrs)
                                 throws MXException,
                                        java.rmi.RemoteException
        Returns zero or one parent object for the given object in the hierarchy. This method returns the immediate parent object of the given object.
        Specified by:
        getParent in interface HierarchicalMboSetRemote
        Parameters:
        object - - name of the object whose children are being requested.
        key - - unique id of the object whose children are being fetched.
        attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.
        Returns:
        MboValueData[] - contains Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.
        Throws:
        MXException
        java.rmi.RemoteException
      • getSiblings

        public MboValueData[][] getSiblings(java.lang.String object,
                                            java.lang.String key,
                                            java.lang.String[] attrs,
                                            int maxRows)
                                     throws MXException,
                                            java.rmi.RemoteException
        Returns zero or more siblings of the given object in the hierarchy.
        Specified by:
        getSiblings in interface HierarchicalMboSetRemote
        Parameters:
        object - - name of the object whose children are being requested.
        key - - unique id of the object whose children are being fetched.
        attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.
        maxRows - - maximum number of rows to return.
        Returns:
        MboValueData[][] - contains an array of Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.
        Throws:
        MXException
        java.rmi.RemoteException
      • getTop

        public MboValueData[][] getTop(java.lang.String[] attrs,
                                       int maxRows)
                                throws MXException,
                                       java.rmi.RemoteException
        Returns all the top level objects in the hierarchy, i.e. objects that do not have parents.
        Specified by:
        getTop in interface HierarchicalMboSetRemote
        Parameters:
        attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.
        maxRows - - maximum number of rows to return.
        Returns:
        MboValueData[][] - contains an array of Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.
        Throws:
        MXException
        java.rmi.RemoteException
      • getPathToTop

        public MboValueData[][] getPathToTop(java.lang.String object,
                                             java.lang.String key,
                                             java.lang.String[] attrs,
                                             int maxRows)
                                      throws MXException,
                                             java.rmi.RemoteException
        Returns all objects in the path to the top from the current object, i.e. every parent of the object in a sequence.
        Specified by:
        getPathToTop in interface HierarchicalMboSetRemote
        Parameters:
        object - - name of the object whose children are being requested.
        key - - unique id of the object whose children are being fetched.
        attrs - - list of attributes whose values are requested, the attribute data returned in the attribute list correspond to this list.
        maxRows - - maximum number of rows to return.
        Returns:
        MboValueData[][] - contains an array of Object name, Object key, hasChildren flag, hasParents flag, list of attributes data from the passed attributes list.
        Throws:
        MXException
        java.rmi.RemoteException