psdi.app.location

Class LocHierarchySet

    • Method Detail

      • getMboInstance

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

        public boolean isChildOfThisLocHierarchyProcessedForDeletion(java.lang.String lochierarchyid)
                                                              throws MXException,
                                                                     java.rmi.RemoteException
        used for networked systems only. Checks to see if the LocHierarchy identified by 'lochierarchyid' has already been processed for deletion. That is, have the children of the LocHierarchy (and their associated LocAncestor records) been considered for deletion?
        Parameters:
        lochierarchyid - unique identifier of the LocHierarchy of interest used to track whether the LocHierarchy has been processed.
        Throws:
        MXException
        java.rmi.RemoteException
      • isLocAncestorAlreadyMarkedForDeletion

        public boolean isLocAncestorAlreadyMarkedForDeletion(java.lang.String locancestorid)
                                                      throws MXException,
                                                             java.rmi.RemoteException
        used for networked systems only. Checks to see if the LocAncestor identified by 'locancestorid' has already been marked for deletion. The same LocAncestor could be processed multiple times in a networked system because a node may have more than one parent, and a node can also be an ancestor and descendant to the same node.
        Parameters:
        locancestorid - unique identifier of the LocAncestor that will be marked for deletion if it has not already been marked for deletion earlier in the process.
        Throws:
        MXException
        java.rmi.RemoteException
      • getDeletionsProcessed

        public java.util.Vector getDeletionsProcessed()
                                               throws MXException,
                                                      java.rmi.RemoteException
        used for networked systems only. This method passes the vector of LocHierarchy records already processed from LocHierarchy set to LocHierarchy set during this recursive process. This occurs during a modification to the LocHierarchy's system. A system modification is the removal of a parent or child within a system.
        Throws:
        MXException
        java.rmi.RemoteException
      • getDeletedLocAncestors

        public java.util.Vector getDeletedLocAncestors()
                                                throws MXException,
                                                       java.rmi.RemoteException
        used for networked systems only. This method passes the vector of LocAncestor records already marked for deletion from LocHierarchy set to LocHierarchy set during this recursive process. This occurs during a modification to the LocHierarchy's system. A system modification is the removal of a parent or child within a system.
        Throws:
        MXException
        java.rmi.RemoteException
      • setDeletionsProcessed

        public void setDeletionsProcessed(java.util.Vector deletionsProcessed)
                                   throws MXException,
                                          java.rmi.RemoteException
        used for networked systems only. This method sets the vector of LocHierarchy records already processed in this LocHierarchySet's ancestor and owning LocHierarchy sets during this recursive process. This occurs during a modification to the LocHierarchy's system. A system modification is the removal of a parent or child within a system.
        Throws:
        MXException
        java.rmi.RemoteException
      • setDeletedLocAncestors

        public void setDeletedLocAncestors(java.util.Vector deletedLocAncestors)
                                    throws MXException,
                                           java.rmi.RemoteException
        used for networked systems only. This method sets the vector of LocAncestor records already marked for deletion in this LocHierarchySet's ancestor and owning LocHierarchy sets during this recursive process. This occurs during a modification to the LocHierarchy's system. A system modification is the removal of a parent or child within a system.
        Throws:
        MXException
        java.rmi.RemoteException
      • recordChildrenOfThisLocHierarchyProcessedForDeletion

        public void recordChildrenOfThisLocHierarchyProcessedForDeletion(java.lang.String lochierarchyid)
                                                                  throws MXException,
                                                                         java.rmi.RemoteException
        used for networked systems only. This method records the LocHierarchy identified by 'lochierarchyid' as already processed for deletion, that is, the children of the LocHierarchy (and their associated LocAncestor records) been considered for deletion.
        Throws:
        MXException
        java.rmi.RemoteException
      • recordLocAncestorAsMarkedForDeletion

        public void recordLocAncestorAsMarkedForDeletion(java.lang.String locancestorid)
                                                  throws MXException,
                                                         java.rmi.RemoteException
        used for networked systems only. This method records the LocAncestor identified by 'locancestorid' as already marked for deletion.
        Throws:
        MXException
        java.rmi.RemoteException
      • recordNewTopLevelLocHierForNetworkedLocHier

        public void recordNewTopLevelLocHierForNetworkedLocHier(java.lang.String newTopLevelLocHier)
                                                         throws MXException,
                                                                java.rmi.RemoteException
        used for networked systems only. This method records is used to record the creation of a new top-level LocHierarchy record. This occurs when a LocHierarchy's parent(s) is/are deleted. Only networked hierarchies can have multiple parents. This record of the top-level addition is necessary because more than one parent can be deleted from a child in one transaction, but only one new top-level LocHierarchy should be added.
        Parameters:
        newTopLevelLocHier - concatenated String of LocHierarchy.Location + LocHierarchy.SystemId +LocHierarchy.SiteId
        Throws:
        MXException
        java.rmi.RemoteException
      • isTopLevelForNetworkedLocHierAdded

        public boolean isTopLevelForNetworkedLocHierAdded(java.lang.String newTopLevelLocHier)
                                                   throws MXException,
                                                          java.rmi.RemoteException
        used for networked systems only. This method records is used to record the creation of a new top-level LocHierarchy record. This occurs when a LocHierarchy's parent(s) is/are deleted. Only networked hierarchies can have multiple parents. This record of the top-level addition is necessary because more than one parent can be deleted from a child in one transaction, but only one new top-level LocHierarchy should be added.
        Parameters:
        newTopLevelLocHier - concatenated String of LocHierarchy.Location + LocHierarchy.SystemId +LocHierarchy.SiteId
        Throws:
        MXException
        java.rmi.RemoteException
      • canAdd

        public void canAdd()
                    throws MXException
        Can an object be added to the collection ? //hierarchical system cannot add more than one parent
        Overrides:
        canAdd in class MboSet
        Throws:
        MXException
      • isLocLocAncCreated

        public boolean isLocLocAncCreated()
      • setLocLocAncCreated

        public void setLocLocAncCreated(boolean locLocAncCreated)
      • save

        public void save(long flags)
                  throws MXException,
                         java.rmi.RemoteException
        Description copied from class: MboSet
        Save the object with the specified flags. Possible flags are :- REBUILD - Maintains the result set after the save. This is more expensive than the default save() option.
        Specified by:
        save in interface MboSetRemote
        Overrides:
        save in class MboSet
        Throws:
        MXException
        java.rmi.RemoteException