com.ibm.tivoli.maximo.map.mapman.app

Class MapManager

  • java.lang.Object
    • psdi.mbo.Mbo
      • com.ibm.tivoli.maximo.map.mapman.app.MapManager
    • Constructor Detail

      • MapManager

        public MapManager(MboSet ms)
                   throws java.rmi.RemoteException
        Throws:
        java.rmi.RemoteException
    • Method Detail

      • appValidate

        public void appValidate()
                         throws MXException,
                                java.rmi.RemoteException
        Checks if the MapManager is activated. Case true, validates all related MapSites, to see if they are already defined in any other active MapManager.
        Overrides:
        appValidate in class Mbo
        Throws:
        MXException
        java.rmi.RemoteException
      • delete

        public void delete(long accessModifier)
                    throws MXException,
                           java.rmi.RemoteException
        Delete MapManager record and all associated sites
        Specified by:
        delete in interface MboRemote
        Overrides:
        delete in class Mbo
        Parameters:
        accessModifier - The bitwise flag specified to determine if certain normal security checks are to be bypassed for this delete request. For example: if the accessModifer is NOACCESSCHECK, then the check for the object's NODELETE flag and the call to the object's canDelete() method will not be performed. If the accessModifer is NONE, then all the access checks are performed before this object is marked delete.
        Throws:
        MXException
        java.rmi.RemoteException
        See Also:
        Mbo.delete(long)
      • undelete

        public void undelete()
                      throws MXException,
                             java.rmi.RemoteException
        Delete MapManager record and all associated sites
        Specified by:
        undelete in interface MboRemote
        Overrides:
        undelete in class Mbo
        Throws:
        MXException
        java.rmi.RemoteException
      • getOrgSiteForMaxvar

        public java.lang.String getOrgSiteForMaxvar(java.lang.String maxvarName)
                                             throws MXException,
                                                    java.rmi.RemoteException
        Description copied from class: Mbo
        Returns org or site for getting maxvar
        Specified by:
        getOrgSiteForMaxvar in interface MboRemote
        Overrides:
        getOrgSiteForMaxvar in class Mbo
        Returns:
        Throws:
        MXException
        java.rmi.RemoteException
      • add

        public void add()
                 throws java.rmi.RemoteException,
                        MXException
        Description copied from class: Mbo
        This is called when a new Mbo is added to the Mboset collection. It is called AFTER user defaults have been set from the data dictionary. Programmer should usually override this to set some defaults. Default behavior is to do nothing.
        Specified by:
        add in interface MboRemote
        Overrides:
        add in class Mbo
        Throws:
        java.rmi.RemoteException
        MXException
      • setAppDefaultValue

        public void setAppDefaultValue()
                                throws MXException,
                                       java.rmi.RemoteException
        Description copied from class: Mbo
        method for setting the default app value for a mbo(appfielddefault table)
        Overrides:
        setAppDefaultValue in class Mbo
        Throws:
        MXException
        java.rmi.RemoteException
      • skipCopyField

        protected boolean skipCopyField(MboValueInfo mvi)
                                 throws java.rmi.RemoteException,
                                        MXException
        This method overrides the skipCopyField() in the MAPMANAGER. This method takes the MboValueInfo as its parameter to see if this field needs to be copied or skipped.If this field does not need to be copied, it returns true. The following fields donot get copied from the source MAPMANAGER to the target MAPMANAGER.
        • mapname
        Overrides:
        skipCopyField in class Mbo
        Parameters:
        mvi - The MboValueInfo object of the MboValue that needs to be copied.
        Returns:
        True,if the field does not need to be copied.In all other cases return false.
        Throws:
        MXException
        java.rmi.RemoteException
      • isSpatialInstalled

        public static java.lang.Boolean isSpatialInstalled()
                                                    throws java.rmi.RemoteException,
                                                           MXException
        Check if Spatial is installed.
        Returns:
        Throws:
        java.rmi.RemoteException
        MXException
      • isAnywhereInstalled

        public static java.lang.Boolean isAnywhereInstalled()
                                                     throws java.rmi.RemoteException,
                                                            MXException
        Check if Anywhere is installed.
        Returns:
        Throws:
        java.rmi.RemoteException
        MXException
      • getGMapsLicense

        public java.lang.String getGMapsLicense()
                                         throws java.rmi.RemoteException,
                                                MXException
        Returns the Google Maps license key (client id)
        Specified by:
        getGMapsLicense in interface MapManagerRemote
        Returns:
        String
        Throws:
        MXException
        java.rmi.RemoteException
      • getGMapsSignature

        public java.lang.String getGMapsSignature()
                                           throws java.rmi.RemoteException,
                                                  MXException
        Returns the Google Maps cryptographic key (api key)
        Specified by:
        getGMapsSignature in interface MapManagerRemote
        Returns:
        String
        Throws:
        MXException
        java.rmi.RemoteException
      • getMapProvider

        public java.lang.String getMapProvider()
                                        throws java.rmi.RemoteException,
                                               MXException
        Returns the provider associated to this map manager object.
        Specified by:
        getMapProvider in interface MapManagerRemote
        Parameters:
        mapManager -
        Returns:
        Throws:
        java.rmi.RemoteException
        MXException
      • isCarbonMap

        public java.lang.Boolean isCarbonMap()
                                      throws java.rmi.RemoteException,
                                             MXException
        Returns the boolean depending on the carbon map flag.
        Specified by:
        isCarbonMap in interface MapManagerRemote
        Parameters:
        mapManager -
        Returns:
        Throws:
        java.rmi.RemoteException
        MXException
      • getMapManagerByNameAndSite

        public static MapManagerRemote getMapManagerByNameAndSite(UserInfo userInfo,
                                                                  java.lang.String mapName,
                                                                  java.lang.String siteId)
                                                           throws MXException,
                                                                  java.rmi.RemoteException
        This method returns a Map Manager from a Site Id and Map Manager Name
        Parameters:
        userInfo -
        mapName -
        siteId -
        Returns:
        Throws:
        MXException
        java.rmi.RemoteException
      • getMapManagerByName

        public static MapManagerRemote getMapManagerByName(java.lang.String mapName,
                                                           UserInfo userInfo)
                                                    throws MXException,
                                                           java.rmi.RemoteException
        This method returns a Map Manager from Name does not validate it Anywhere or Mobile
        Parameters:
        userInfo -
        mapName -
        siteId -
        Returns:
        Throws:
        MXException
        java.rmi.RemoteException
      • getMapManager

        public static MapManagerRemote getMapManager(UserInfo user,
                                                     boolean isMobileMapManager)
                                              throws MXException,
                                                     java.rmi.RemoteException
        This method considers the isMobile flag, added by Anywhere project + Spatial
        Parameters:
        user -
        isMobileMapManager -
        Returns:
        Throws:
        MXException
        java.rmi.RemoteException
      • getCarbonMapManager

        public static MapManagerRemote getCarbonMapManager(UserInfo user,
                                                           boolean isMobileMapManager)
                                                    throws MXException,
                                                           java.rmi.RemoteException
        This method considers the isMobile flag, added by Anywhere project + Spatial
        Parameters:
        user -
        isMobileMapManager -
        Returns:
        Throws:
        MXException
        java.rmi.RemoteException
      • getCarbonMapManagerByNameAndSite

        public static MapManagerRemote getCarbonMapManagerByNameAndSite(UserInfo userInfo,
                                                                        java.lang.String mapName,
                                                                        java.lang.String siteId)
                                                                 throws MXException,
                                                                        java.rmi.RemoteException
        This method returns a Map Manager from a Site Id and Map Manager Name
        Parameters:
        userInfo -
        mapName -
        siteId -
        Returns:
        Throws:
        MXException
        java.rmi.RemoteException
      • save

        protected void save()
                     throws MXException,
                            java.rmi.RemoteException
        Description copied from class: Mbo
        Save the object and other linked objects. Subclasses can code their save() logic to include any appropriate updates to other linked objects and call super.save().
        Overrides:
        save in class Mbo
        Throws:
        MXException
        java.rmi.RemoteException
      • generateAndUpdateMapConfigurationObject

        public MapConfiguration generateAndUpdateMapConfigurationObject()
                                                                 throws MXException,
                                                                        java.io.IOException
        Description copied from interface: MapManagerRemote
        Generates both XML and JSON map configuration definitions files for the current map manager record. And saves the generated map configuration definitions on the current map manager record.
        Specified by:
        generateAndUpdateMapConfigurationObject in interface MapManagerRemote
        Returns:
        generated map configuration definition
        Throws:
        MXException
        java.io.IOException
      • getOpenMapProvider

        public java.lang.String getOpenMapProvider()
                                            throws java.rmi.RemoteException,
                                                   MXException
        Returns the OpenMap provider associated to this map manager object.
        Specified by:
        getOpenMapProvider in interface MapManagerRemote
        Parameters:
        mapManager -
        Returns:
        Throws:
        java.rmi.RemoteException
        MXException
      • getOpenMapURL

        public java.lang.String getOpenMapURL()
                                       throws java.rmi.RemoteException,
                                              MXException
        Returns the OpenStreetMap URL associated to this map manager object.
        Specified by:
        getOpenMapURL in interface MapManagerRemote
        Returns:
        Throws:
        java.rmi.RemoteException
        MXException
      • getPreloadBboxList

        public java.util.List getPreloadBboxList(MboSetRemote preloadMboSet)
                                          throws java.rmi.RemoteException,
                                                 MXException
        Returns preload bbox list with mbo data
        Parameters:
        preloadMboSet -
        Returns:
        Throws:
        java.rmi.RemoteException
        MXException
      • getMapManager

        public static MboRemote getMapManager(java.lang.String siteId,
                                              UserInfo user)
                                       throws java.rmi.RemoteException,
                                              MXException
        Parameters:
        mapSite -
        Returns:
        Throws:
        java.rmi.RemoteException
        MXException