Class GetStaticVaraRows


  • public class GetStaticVaraRows
    extends XMLRequest
    Returns a list of rows according to the specified key-filters supplied by the constructor.
    • Constructor Detail

      • GetStaticVaraRows

        public GetStaticVaraRows​(UC4ObjectName objectName,
                                 java.lang.String... keys)
        Creates a new instance of the GetStaticVaraRows request.
        Parameters:
        objectName - The variable name
        keys - A list of keys to request the variable rows
    • Method Detail

      • getSrc

        protected java.lang.String getSrc()
        Description copied from class: XMLRequest
        Returns the request source. This method is used internally.
        Specified by:
        getSrc in class XMLRequest
        Returns:
        Source
      • isAllowedInClientZero

        protected boolean isAllowedInClientZero()
        Description copied from class: XMLRequest
        This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.
        Overrides:
        isAllowedInClientZero in class XMLRequest
        Returns:
        true if this request is allowed in client 0, false otherwise
      • createRequest

        protected void createRequest​(com.uc4.util.XMLDocument doc,
                                     org.w3c.dom.Element request,
                                     ConnectionAttributes sessionInfo)
        Description copied from class: XMLRequest
        Creates the XML Document for the request. This method is used internally.
        Specified by:
        createRequest in class XMLRequest
        Parameters:
        doc - Document, used to create new Elements
        request - Request Element - classes append information to this request element
        sessionInfo - Information about the session
      • handleContent

        protected void handleContent​(com.uc4.util.XMLDocument doc,
                                     ConnectionAttributes session)
        Description copied from class: XMLRequest
        Sub classes extract the values from the XML document and provide public getter methods.
        Overrides:
        handleContent in class XMLRequest
        Parameters:
        doc - XML Document
        session - Info about the user session
      • keyIterator

        public java.util.Iterator<java.lang.String> keyIterator()
        Returns an java.util.Iterator of validity keywords. Each validity keyword is stored as java.lang.String. The order of the returned validity keywords is undefined.
        Returns:
        Iterator
      • getRow

        public java.lang.String[] getRow​(java.lang.String key)
        Returns all values of the row with the specified key as String array.
        Parameters:
        key - Key, must be unique
        Returns:
        Array of Strings containing the values
      • get

        public java.lang.String get​(java.lang.String key)
        Returns the value for the given validity keyword.
        Parameters:
        key - validity keyword
        Returns:
        value