DSResponse (Smart GWT LGPL Edition API 5.1p (2022-05-28))

java.lang.Object
- com.smartgwt.client.core.JsObject
- - com.smartgwt.client.core.DataClass
  - - com.smartgwt.client.rpc.RPCResponse
    - - com.smartgwt.client.data.DSResponse

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers
```
public class DSResponse
extends RPCResponse
```
Response sent by the server in response to a DataSource request. Contains all the properties available on the basic RPCResponse, in addition to the properties listed here.

Field Summary
- Fields inherited from class com.smartgwt.client.rpc.RPCResponse
  INVALID_RESPONSE_FORMAT, STATUS_AUTHORIZATION_FAILURE, STATUS_CONNECTION_RESET_ERROR, STATUS_FAILURE, STATUS_LOGIN_INCORRECT, STATUS_LOGIN_REQUIRED, STATUS_LOGIN_SUCCESS, STATUS_MAX_FILE_SIZE_EXCEEDED, STATUS_MAX_LOGIN_ATTEMPTS_EXCEEDED, STATUS_MAX_POST_SIZE_EXCEEDED, STATUS_OFFLINE, STATUS_SERVER_TIMEOUT, STATUS_SUCCESS, STATUS_TRANSACTION_FAILED, STATUS_TRANSPORT_ERROR, STATUS_UNKNOWN_HOST_ERROR, STATUS_UPDATE_WITHOUT_PK_ERROR, STATUS_VALIDATION_ERROR
- Fields inherited from class com.smartgwt.client.core.DataClass
  factoryCreated, factoryProperties, readOnly
- Fields inherited from class com.smartgwt.client.core.JsObject
  jsObj

Constructor Summary

Constructors
Constructor and Description
`DSResponse()`
`DSResponse(com.google.gwt.core.client.JavaScriptObject jsObj)`
`DSResponse(java.lang.String dataSource)`
`DSResponse(java.lang.String dataSource, DSOperationType operationType)`
`DSResponse(java.lang.String dataSource, DSOperationType operationType, Record... data)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Record[]`	`getData()` For "fetch" operations, this is the array of Records fetched.
`RecordList`	`getDataAsRecordList()` For "fetch" operations, this is the array of Records fetched.
`java.lang.String`	`getDataSource()` The DataSource of this DSResponse.
`java.lang.Integer`	`getEndRow()` End row of returned server results, when using paged result fetching
`java.util.Map`	`getErrors()` Server-side validation errors for an attempted "update" or "add" operation, as a JS Object where each property name is a field name from the record and each property value is an error message to be shown to the user.
`java.lang.Boolean`	`getFromOfflineCache()` If set, indicates that this response came from the offline cache, not the server.
`java.util.Map`	`getHttpHeaders()` HTTP headers returned by the server as a map from header name to header value.
`java.lang.Boolean`	`getInvalidateCache()` Optional flag that can be set by the server to force ResultSets to drop any caches of records from the DataSource that was the target of the operation.
`java.lang.Integer`	`getOfflineTimestamp()` Timestamp (millisecond value) to indicate when this dsResponse was cached in `offline storage`.
`java.lang.String`	`getOperationId()` The operation ID of the request corresponding to this DSResponse.
`DSOperationType`	`getOperationType()` The operation type of the request corresponding to this DSResponse.
`static DSResponse`	`getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
`int`	`getQueueStatus()` An extra property of each DSResponse to a queued request that indicates whether the queue as a whole succeeded.
`java.lang.Integer`	`getStartRow()` Starting row of returned server results, when using paged result fetching
`int`	`getStatus()` Same meaning as `RPCResponse.status`, except DSResponses have additional error codes, such as `validation failure`.
`java.lang.Integer`	`getTotalRows()` Total number of rows available from the server that match the current filter criteria, when using paged result fetching.
`void`	`setData(Record... data)` For "fetch" operations, this is the array of Records fetched.
`void`	`setDataSource(java.lang.String dataSource)` The DataSource of this DSResponse.
`void`	`setEndRow(java.lang.Integer endRow)` End row of returned server results, when using paged result fetching
`void`	`setErrors(com.google.gwt.core.client.JavaScriptObject errors)` Server-side validation errors for an attempted "update" or "add" operation, as a JS Object where each property name is a field name from the record and each property value is an error message to be shown to the user.
`void`	`setErrors(java.util.Map errors)` Server-side validation errors for an attempted "update" or "add" operation, as a JS Object where each property name is a field name from the record and each property value is an error message to be shown to the user.
`void`	`setInvalidateCache(java.lang.Boolean invalidateCache)` Optional flag that can be set by the server to force ResultSets to drop any caches of records from the DataSource that was the target of the operation.
`void`	`setOperationId(java.lang.String operationId)` The operation ID of the request corresponding to this DSResponse.
`void`	`setOperationType(DSOperationType operationType)` The operation type of the request corresponding to this DSResponse.
`void`	`setQueueStatus(int queueStatus)` An extra property of each DSResponse to a queued request that indicates whether the queue as a whole succeeded.
`void`	`setStartRow(java.lang.Integer startRow)` Starting row of returned server results, when using paged result fetching
`void`	`setStatus(int status)` Same meaning as `RPCResponse.status`, except DSResponses have additional error codes, such as `validation failure`.
`void`	`setTotalRows(java.lang.Integer totalRows)` Total number of rows available from the server that match the current filter criteria, when using paged result fetching.

Methods inherited from class com.smartgwt.client.rpc.RPCResponse
create, getDataAsMap, getDataAsObject, getDataAsString, getHttpResponseCode, getHttpResponseText, getTransactionNum

Methods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, getReadOnly, isFactoryCreated, logConfiguration, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated, setReadOnly

Methods inherited from class com.smartgwt.client.core.JsObject
equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DSResponse
```
public DSResponse()
```
  - DSResponse
```
public DSResponse(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - DSResponse
```
public DSResponse(java.lang.String dataSource)
```
  - DSResponse
```
public DSResponse(java.lang.String dataSource,
                  DSOperationType operationType)
```
  - DSResponse
```
public DSResponse(java.lang.String dataSource,
                  DSOperationType operationType,
                  Record... data)
```
- Method Detail
  - getOrCreateRef
```
public static DSResponse getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
```
  - getData
```
public Record[] getData()
```
    For "fetch" operations, this is the array of Records fetched. For "update", "add", and "remove" operations, this is typically an array containing a single Record representing the record that was updated, added, or removed.
    
    Returns:
    
    Record...
  - getDataAsRecordList
```
public RecordList getDataAsRecordList()
```
    For "fetch" operations, this is the array of Records fetched. For "update", "add", and "remove" operations, this is typically an array containing a single Record representing the record that was updated, added, or removed.
    
    Returns:
    
    RecordList
  - setDataSource
```
public void setDataSource(java.lang.String dataSource)
```
    The DataSource of this DSResponse.
    
    Parameters:
    
    dataSource - Default value is null
  - getDataSource
```
public java.lang.String getDataSource()
```
    The DataSource of this DSResponse.
    
    Returns:
    
    String
  - getEndRow
```
public java.lang.Integer getEndRow()
```
    End row of returned server results, when using paged result fetching
    Note that startRow and endRow are zero-based, inclusive at the beginning and exclusive at the end (like substring), so startRow: 0, endRow: 2 is a response containing two records.
    
    Returns:
    
    Integer
  - getFromOfflineCache
```
public java.lang.Boolean getFromOfflineCache()
```
    If set, indicates that this response came from the offline cache, not the server. This flag is the only reliable way for application code to determine the source of a response.
    
    Returns:
    
    Boolean
  - getHttpHeaders
```
public java.util.Map getHttpHeaders()
```
    HTTP headers returned by the server as a map from header name to header value.
    Headers are available only when the default RPCTransport "xmlHttpRequest" is in use, and browsers may limit access to headers for cross-domain requests or in other security-sensitive scenarios.
    
    Overrides:
    
    getHttpHeaders in class RPCResponse
    
    Returns:
    
    Map
  - getInvalidateCache
```
public java.lang.Boolean getInvalidateCache()
```
    Optional flag that can be set by the server to force ResultSets to drop any caches of records from the DataSource that was the target of the operation.
    
    Returns:
    
    Boolean
  - getOfflineTimestamp
```
public java.lang.Integer getOfflineTimestamp()
```
    Timestamp (millisecond value) to indicate when this dsResponse was cached in offline storage. Not applicable if the response has never been stored offline.
    
    Returns:
    
    Integer
  - setOperationId
```
public void setOperationId(java.lang.String operationId)
```
    The operation ID of the request corresponding to this DSResponse.
    
    Parameters:
    
    operationId - Default value is null
  - getOperationId
```
public java.lang.String getOperationId()
```
    The operation ID of the request corresponding to this DSResponse.
    
    Returns:
    
    String
  - setOperationType
```
public void setOperationType(DSOperationType operationType)
```
    The operation type of the request corresponding to this DSResponse.
    
    Parameters:
    
    operationType - Default value is null
  - getOperationType
```
public DSOperationType getOperationType()
```
    The operation type of the request corresponding to this DSResponse.
    
    Returns:
    
    DSOperationType
  - setQueueStatus
```
public void setQueueStatus(int queueStatus)
```
    An extra property of each DSResponse to a queued request that indicates whether the queue as a whole succeeded. A queueStatus of STATUS_SUCCESS, or 0, indicates that the queue succeeded whereas a queueStatus of STATUS_FAILURE, or -1, indicates that the queue failed.
    For example, if two "update" requests are sent in a queue and the first succeeded, but the second failed validation, then both DSResponses' queueStatus would be -1, but the status of the first would be STATUS_SUCCESS and the status of the second would be an error code such as STATUS_VALIDATION_ERROR.
    
    Parameters:
    
    queueStatus - Default value is see below
    
    See Also:
    
    ErrorHandling overview and related methods
  - getQueueStatus
```
public int getQueueStatus()
```
    An extra property of each DSResponse to a queued request that indicates whether the queue as a whole succeeded. A queueStatus of STATUS_SUCCESS, or 0, indicates that the queue succeeded whereas a queueStatus of STATUS_FAILURE, or -1, indicates that the queue failed.
    For example, if two "update" requests are sent in a queue and the first succeeded, but the second failed validation, then both DSResponses' queueStatus would be -1, but the status of the first would be STATUS_SUCCESS and the status of the second would be an error code such as STATUS_VALIDATION_ERROR.
    
    Returns:
    
    int
    
    See Also:
    
    ErrorHandling overview and related methods
  - getStartRow
```
public java.lang.Integer getStartRow()
```
    Starting row of returned server results, when using paged result fetching
    Note that startRow and endRow are zero-based, inclusive at the beginning and exclusive at the end (like substring), so startRow: 0, endRow: 2 is a response containing two records.
    
    Returns:
    
    Integer
  - setStatus
```
public void setStatus(int status)
```
    Same meaning as RPCResponse.status, except DSResponses have additional error codes, such as validation failure.
    
    Overrides:
    
    setStatus in class RPCResponse
    
    Parameters:
    
    status - Default value is see below
    
    See Also:
    
    ErrorHandling overview and related methods
  - getStatus
```
public int getStatus()
```
    Same meaning as RPCResponse.status, except DSResponses have additional error codes, such as validation failure.
    
    Overrides:
    
    getStatus in class RPCResponse
    
    Returns:
    
    int
    
    See Also:
    
    ErrorHandling overview and related methods
  - getTotalRows
```
public java.lang.Integer getTotalRows()
```
    Total number of rows available from the server that match the current filter criteria, when using paged result fetching.
    
    Returns:
    
    Integer
  - setStartRow
```
public void setStartRow(java.lang.Integer startRow)
```
    Starting row of returned server results, when using paged result fetching
    Note that startRow and endRow are zero-based - the first record is row zero.
    
    Parameters:
    
    startRow - the start row
  - setEndRow
```
public void setEndRow(java.lang.Integer endRow)
```
    End row of returned server results, when using paged result fetching
    Note that startRow and endRow are zero-based - the first record is row zero.
    
    Parameters:
    
    endRow - the end row
  - setTotalRows
```
public void setTotalRows(java.lang.Integer totalRows)
```
    Total number of rows available from the server that match the current filter criteria, when using paged result fetching.
    
    Parameters:
    
    totalRows - total rows
  - setInvalidateCache
```
public void setInvalidateCache(java.lang.Boolean invalidateCache)
```
    Optional flag that can be set by the server to force ResultSets to drop any caches of records from the DataSource that was the target of the operation.
    
    Parameters:
    
    invalidateCache - invalidateCache
  - setErrors
```
public void setErrors(java.util.Map errors)
```
    Server-side validation errors for an attempted "update" or "add" operation, as a JS Object where each property name is a field name from the record and each property value is an error message to be shown to the user. For example:
```
     dsResponse.errors = {         userId : "A user with this userId already exists",
 orderId : "No Order with ID '6A18294' exists"     } 
```
    The Java API DSResponse.addError(fieldName, errorMessage) is used to send server-side errors to the client. See the Java Server Reference for details.
    Parameters:
    
    errors - errors map
  - setErrors
```
public void setErrors(com.google.gwt.core.client.JavaScriptObject errors)
```
    Server-side validation errors for an attempted "update" or "add" operation, as a JS Object where each property name is a field name from the record and each property value is an error message to be shown to the user. For example:
```
     dsResponse.errors = {         userId : "A user with this userId already exists",
 orderId : "No Order with ID '6A18294' exists"     } 
```
    The Java API DSResponse.addError(fieldName, errorMessage) is used to send server-side errors to the client. See the Java Server Reference for details.
    Parameters:
    
    errors - errors as JavaScriptObject
  - setData
```
public void setData(Record... data)
```
    For "fetch" operations, this is the array of Records fetched. For "update", "add", and "remove" operations, this is typically an array containing a single Record representing the record that was updated, added, or removed.
    
    Parameters:
    
    data - data Default value is null
  - getErrors
```
public java.util.Map getErrors()
```
    Server-side validation errors for an attempted "update" or "add" operation, as a JS Object where each property name is a field name from the record and each property value is an error message to be shown to the user. For example:
```
      {
        userId : ["A user with this userId already exists"],
        orderId : ["Must be a numeric value", "No Order with ID '6A18294' exists"]
      }
 
```
    The Java API DSResponse.addError(fieldName, errorMessage) is used to send server-side errors to the client. See the Java Server Reference for details.
    Returns:
    
    the errors map

Class DSResponse

Field Summary

Fields inherited from class com.smartgwt.client.rpc.RPCResponse

Fields inherited from class com.smartgwt.client.core.DataClass

Fields inherited from class com.smartgwt.client.core.JsObject

Constructor Summary

Method Summary

Methods inherited from class com.smartgwt.client.rpc.RPCResponse

Methods inherited from class com.smartgwt.client.core.DataClass

Methods inherited from class com.smartgwt.client.core.JsObject

Methods inherited from class java.lang.Object

Constructor Detail

DSResponse

DSResponse

DSResponse

DSResponse

DSResponse

Method Detail

getOrCreateRef

getData

getDataAsRecordList

setDataSource

getDataSource

getEndRow

getFromOfflineCache

getHttpHeaders

getInvalidateCache

getOfflineTimestamp

setOperationId

getOperationId

setOperationType

getOperationType

setQueueStatus

getQueueStatus

getStartRow

setStatus

getStatus

getTotalRows

setStartRow

setEndRow

setTotalRows

setInvalidateCache

setErrors

setErrors

setData

getErrors