Package com.uc4.communication.requests
Class PreviewVariable
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.PreviewVariable
Preview of an SQL and Backend Variables.
-
Constructor Summary
ConstructorsConstructorDescriptionPreviewVariable
(Variable var) Creates a new Preview Request for SQL Variables.PreviewVariable
(UC4ObjectName name) Creates a new Preview Request for dynamic Variables. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
createRequest
(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.String[]
Returns a String array which contains the names of the columns.String[]
getRow
(int index) Returns the data of the specified row.protected String
getSrc()
Returns the request source.Returns the type of the variable.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
This method is used internally.int
size()
Returns the number of data rows in the preview.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 Details
-
PreviewVariable
Creates a new Preview Request for SQL Variables.- Parameters:
var
- Internal or external SQL Variable
-
PreviewVariable
Creates a new Preview Request for dynamic Variables.- Parameters:
name
- Name of the variable object
-
-
Method Details
-
getSrc
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- Returns:
- Source
-
createRequest
protected void createRequest(com.uc4.util.XMLDocument doc, 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
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
-
getSubType
Returns the type of the variable.- Returns:
- For example SQLI_SEC or an empty String if this information is not available
- Since:
- V12
-
size
public int size()Returns the number of data rows in the preview.- Returns:
- Number of rows
-
getRow
Returns the data of the specified row.- Parameters:
index
- Index,0
tosize() -1
- Returns:
- String array containing the data
-
getColumnNames
Returns a String array which contains the names of the columns.- Returns:
- Column names
-
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
-