com.uc4.communication.requests

Class GetStaticVaraRows

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetStaticVaraRows

public class GetStaticVaraRows
extends XMLRequest

Returns a list of rows according to the specified key-filters supplied by the constructor.

Constructor Summary

Constructors

Constructor and Description
GetStaticVaraRows(UC4ObjectName objectName, java.lang.String... keys) Creates a new instance of the GetStaticVaraRows request.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	get(java.lang.String key) Returns the value for the given validity keyword.
java.lang.String[]	getRow(java.lang.String key) Returns all values of the row with the specified key as String array.
java.util.Iterator<java.lang.String>	keyIterator() Returns an java.util.Iterator of validity keywords.

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send

Methods inherited from class java.lang.Object

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

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

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