Package com.uc4.api.objects

Class OCVPanel

  • All Implemented Interfaces:
    java.lang.Iterable<OCVPanel.CITValue>
    public class OCVPanel
extends java.lang.Object
implements java.lang.Iterable<OCVPanel.CITValue>
    This class provides access to the values of Connection Objects and Rapid Automation Jobs.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OCVPanel.CITValue
      This class represents a single row in this panel.

    • Constructor Summary

      Constructors 
      Constructor Description
      OCVPanel​(com.uc4.util.XMLDocument doc, org.w3c.dom.Element citPanel, ConnectionAttributes session)
      Internal use only.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(OCVPanel.CITValue value)
      Adds a new value to this panel.
      boolean changeValue​(java.lang.String xmlName, java.lang.String value)
      Modifies the value of an xmlName.
      void clear()
      Removes all values from this connection object.
      OCVPanel copy()
      Creates a deep copy of this object
      java.lang.String get​(java.lang.String name)
      Gets a value from by its unique name.
      int getInt​(java.lang.String name)
      Gets a value by its name and converts the result to an integer.
      java.util.Iterator<OCVPanel.CITValue> iterator()
      Returns an iterator which can be used ot read all values.
      boolean remove​(java.lang.String name)
      Removes a value from this OCV Panel instance.
      void setValue​(java.lang.String xmlName, java.lang.String value, boolean enc, boolean con)
      Modifies or adds a new value to this OCV panel.
      int size()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • OCVPanel

        public OCVPanel​(com.uc4.util.XMLDocument doc,
                org.w3c.dom.Element citPanel,
                ConnectionAttributes session)
        Internal use only.
        Parameters:
        doc - XML document
        citPanel - Element of RA values
        session - Session info

    • Method Detail

      • get

        public java.lang.String get​(java.lang.String name)
        Gets a value from by its unique name.
        Parameters:
        name - xmlName
        Returns:
        value or null if not found

      • getInt

        public int getInt​(java.lang.String name)
        Gets a value by its name and converts the result to an integer.
        Parameters:
        name - xmlName of the parameter
        Returns:
        int (0 if not found, -1 in case of a NumberFormatException)

      • remove

        public boolean remove​(java.lang.String name)
        Removes a value from this OCV Panel instance.
        Parameters:
        name - XML name
        Returns:
        true if the value has been removed, false otherwise

      • iterator

        public java.util.Iterator<OCVPanel.CITValue> iterator()
        Returns an iterator which can be used ot read all values.
        Specified by:
        iterator in interface java.lang.Iterable<OCVPanel.CITValue>
        Returns:
        Iterator over CITValue

      • clear

        public void clear()
        Removes all values from this connection object.

      • add

        public void add​(OCVPanel.CITValue value)
        Adds a new value to this panel.
        Parameters:
        value - CITValue

      • changeValue

        public boolean changeValue​(java.lang.String xmlName,
                           java.lang.String value)
        Modifies the value of an xmlName.
        Parameters:
        xmlName - Name
        value - New value
        Returns:
        true if successful, false otherwise

      • setValue

        public void setValue​(java.lang.String xmlName,
                     java.lang.String value,
                     boolean enc,
                     boolean con)
        Modifies or adds a new value to this OCV panel.
        Parameters:
        xmlName - Name
        value - Value
        enc - Encryption?
        con - Connection Object

      • size

        public int size()
        Returns:
        Number of entries

      • copy

        public OCVPanel copy()
        Creates a deep copy of this object
        Returns:
        A copy of this object