Package 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 Description GetStaticVaraRows(UC4ObjectName objectName, java.lang.String... keys)
Creates a new instance of theGetStaticVaraRows
request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
Creates the XML Document for the request.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.protected java.lang.String
getSrc()
Returns the request source.protected void
handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
Sub classes extract the values from the XML document and provide public getter methods.protected boolean
isAllowedInClientZero()
This method is used internally.java.util.Iterator<java.lang.String>
keyIterator()
Returns anjava.util.Iterator
of validity keywords.-
Methods inherited from class com.uc4.communication.requests.XMLRequest
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
-
-
-
-
Constructor Detail
-
GetStaticVaraRows
public GetStaticVaraRows(UC4ObjectName objectName, java.lang.String... keys)
Creates a new instance of theGetStaticVaraRows
request.- Parameters:
objectName
- The variable namekeys
- 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 classXMLRequest
- Returns:
- Source
-
isAllowedInClientZero
protected boolean isAllowedInClientZero()
Description copied from class:XMLRequest
This method is used internally. Tests if thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- 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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- 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 classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
keyIterator
public java.util.Iterator<java.lang.String> keyIterator()
Returns anjava.util.Iterator
of validity keywords. Each validity keyword is stored asjava.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
-
-