psdi.iface.proc

Class ControlsCache

    • Method Detail

      • getName

        public java.lang.String getName()
        Return name to be registered in the cashe to reload
        Returns:
        Throws:
        MXException - MAXIMO exception
      • getAllControls

        public java.util.Map getAllControls(java.lang.String extSystem)
        Gets all controls info
        Returns:
        ifacecontrols table loaded in memory
      • getIfaceControlInfo

        public MaxIfaceControlInfo getIfaceControlInfo(java.lang.String extSystem,
                                                       java.lang.String name)
                                                throws MXException
        Gets all systems info for the specific control in the external system
        Parameters:
        name - Control name
        Returns:
        MaxIfaceControlInfo object for control in the external system
        Throws:
        MXException - MAXIMO exception
      • getControlType

        public java.lang.String getControlType(java.lang.String extSystem,
                                               java.lang.String name)
                                        throws MXException
        Gets control type for the control
        Parameters:
        extSystem - External System name
        name - Control name
        Returns:
        Control Type
        Throws:
        MXException - MAXIMO exception
      • getInternalControlType

        public java.lang.String getInternalControlType(java.lang.String extSystem,
                                                       java.lang.String name)
                                                throws MXException
        Gets Internal Control Type
        Parameters:
        extSystem - External System name
        name - Control name
        Returns:
        Internal Control Type
        Throws:
        MXException - MAXIMO exception
      • getControlAsList

        protected java.util.ArrayList getControlAsList(java.lang.String extsys,
                                                       java.lang.String name,
                                                       java.lang.String orgid,
                                                       java.lang.String siteid)
                                                throws MXException
        Gets control value for VALUE and LIST type controls as list
        Parameters:
        name - Control name
        orgid - Organization
        siteid - Site
        Returns:
        ArrayList of all values for control
        Throws:
        MXException - MAXIMO exception
      • isControlEqual

        public boolean isControlEqual(java.lang.String extsys,
                                      java.lang.String name,
                                      java.lang.String value)
                               throws MXException
        Compares control with a value
        Parameters:
        extsys - External System name
        name - Control name
        value - Value to compare
        Returns:
        TRUE/FALSE for control to be equal to the value
        Throws:
        MXException - MAXIMO exception
      • isControlEqual

        public boolean isControlEqual(java.lang.String extsys,
                                      java.lang.String name,
                                      java.lang.String orgid,
                                      java.lang.String siteid,
                                      java.lang.String value)
                               throws MXException
        Gets control value for VALUE type controls
        Parameters:
        name - Control name
        orgid - Organization
        siteid - Site
        value - Value to compare
        Returns:
        TRUE/FALSE for control to be equal to the value
        Throws:
        MXException - MAXIMO exception
      • getValueControl

        public java.lang.String getValueControl(java.lang.String extsys,
                                                java.lang.String name)
                                         throws MXException
        Gets control value for VALUE type controls
        Parameters:
        name - Control name
        Returns:
        Value for control
        Throws:
        MXException - MAXIMO exception
      • getValueOrBooleanControl

        public java.lang.String getValueOrBooleanControl(java.lang.String extsys,
                                                         java.lang.String name,
                                                         java.lang.String orgid,
                                                         java.lang.String siteid)
                                                  throws MXException
        Gets control value for VALUE type controls
        Parameters:
        name - Control name
        orgid - Organization
        siteid - Site
        Returns:
        Value for control
        Throws:
        MXException - MAXIMO exception
      • getValueControl

        public java.lang.String getValueControl(java.lang.String extsys,
                                                java.lang.String name,
                                                java.lang.String orgid,
                                                java.lang.String siteid)
                                         throws MXException
        Gets control value for VALUE type controls
        Parameters:
        name - Control name
        orgid - Organization
        siteid - Site
        Returns:
        Value for control
        Throws:
        MXException - MAXIMO exception
      • isValueControlNull

        public boolean isValueControlNull(java.lang.String extsys,
                                          java.lang.String name)
                                   throws MXException
        Check control value for VALUE type controls being null
        Parameters:
        name - Control name
        Returns:
        TRUE/FALSE for control to be null
        Throws:
        MXException - MAXIMO exception
      • isValueControlNull

        public boolean isValueControlNull(java.lang.String extsys,
                                          java.lang.String name,
                                          java.lang.String orgid,
                                          java.lang.String siteid)
                                   throws MXException
        Chueck control value for VALUE type controls being null
        Parameters:
        name - Control name
        orgid - Organization
        siteid - Site
        Returns:
        TRUE/FALSE for control to be null
        Throws:
        MXException - MAXIMO exception
      • isControlExists

        public boolean isControlExists(java.lang.String extsys,
                                       java.lang.String controlName)
                                throws MXException
        Check whether the given control exists for the given external system. Returns true if the control exists, false otherwise
        Parameters:
        extsys - external system name
        controlName - control name
        Returns:
        true or false
        Throws:
        MXException - Maximo Exception
      • getXREFControl

        public java.util.List getXREFControl(java.lang.String extsys,
                                             java.lang.String name,
                                             java.lang.String currentValue,
                                             boolean fromMaximo)
                                      throws MXException
        Gets control value for CrossRference type controls
        Parameters:
        name - Control name
        currentValue - Value to fine CrossRefernce for
        fromMaximo - Direction of CrossReference control FROM/TO MAXIMO
        Returns:
        Value for control
        Throws:
        MXException - MAXIMO exception
      • getXREFControlValue

        public java.lang.String getXREFControlValue(java.lang.String extsys,
                                                    java.lang.String name,
                                                    java.lang.String orgid,
                                                    java.lang.String siteid,
                                                    java.lang.String currentValue,
                                                    boolean fromMaximo)
                                             throws MXException
        Gets control value for Crossrefrence type controls
        Parameters:
        name - Control name
        orgid - Organization
        siteid - Site
        currentValue - Value to fine CrossRefernce for
        fromMaximo - Direction of CrossReference control FROM/TO MAXIMO
        Returns:
        Value for control
        Throws:
        MXException - MAXIMO exception
      • getXREFControl

        public java.util.List getXREFControl(java.lang.String extsys,
                                             java.lang.String name,
                                             java.lang.String orgid,
                                             java.lang.String siteid,
                                             java.lang.String currentValue,
                                             boolean fromMaximo)
                                      throws MXException
        Gets control value for Crossrefrence type controls
        Parameters:
        name - Control name
        orgid - Organization
        siteid - Site
        currentValue - Value to fine CrossRefernce for
        fromMaximo - Direction of CrossReference control FROM/TO MAXIMO
        Returns:
        List Values for control
        Throws:
        MXException - MAXIMO exception
      • getXREFControlValues

        public java.util.List getXREFControlValues(java.lang.String extsys,
                                                   java.lang.String name)
                                            throws MXException
        Gets control value for CrossRefrence type controls
        Parameters:
        name - Control name
        Returns:
        List Values for control
        Throws:
        MXException - MAXIMO exception
      • doesXREFExist

        public boolean doesXREFExist(java.lang.String extsys,
                                     java.lang.String name,
                                     java.lang.String orgid,
                                     java.lang.String siteid,
                                     java.lang.String currentValue,
                                     boolean fromMaximo)
                              throws MXException
        Find out is CrossRefrence exists for the Given Value
        Parameters:
        name - Control name
        orgid - Organization
        siteid - Site
        currentValue - Value to fine CrossRefernce for
        fromMaximo - Direction of CrossReference control FROM/TO MAXIMO
        Returns:
        TRUE/FALSE depending if Cross refrence exists
        Throws:
        MXException - MAXIMO exception
      • getListControl

        public java.util.List getListControl(java.lang.String extsys,
                                             java.lang.String name)
                                      throws MXException
        Gets control value for List type controls
        Parameters:
        name - Control name
        Returns:
        List Values for control
        Throws:
        MXException - MAXIMO exception
      • getListControl

        public java.util.ArrayList getListControl(java.lang.String extsys,
                                                  java.lang.String name,
                                                  java.lang.String orgid,
                                                  java.lang.String siteid)
                                           throws MXException
        Gets control value for List type controls
        Parameters:
        name - Control name
        orgid - Organization
        siteid - Site
        Returns:
        List Values for control
        Throws:
        MXException - MAXIMO exception
      • isControlTrue

        public boolean isControlTrue(java.lang.String extsys,
                                     java.lang.String name)
                              throws MXException
        Gets control value for Boolean type controls and evaluates it to true
        Parameters:
        name - Control name
        Returns:
        TRUE/FALSE depending if control value
        Throws:
        MXException - MAXIMO exception
      • isControlTrue

        public boolean isControlTrue(java.lang.String extsys,
                                     java.lang.String name,
                                     java.lang.String orgid,
                                     java.lang.String siteid)
                              throws MXException
        Gets control value for List type controls and evaluates it to true
        Parameters:
        name - Control name
        orgid - Organization
        siteid - Site
        Returns:
        TRUE/FALSE depending if control value
        Throws:
        MXException - MAXIMO exception
      • setXREFValues

        public void setXREFValues(java.util.Map inMap,
                                  java.lang.String key,
                                  java.lang.String val1,
                                  java.lang.String val2)
                           throws MXException
        Gets control value for cross-reference type controls
        Parameters:
        inMap - Map of the values
        key - key name
        val1 - value to replace
        val2 - new value
        Throws:
        MXException - MAXIMO exception