edu.mayo.bsi.ngsportal.server
Class GwtRpcDataSource

java.lang.Object
  com.smartgwt.client.core.BaseClass
      com.smartgwt.client.data.DataSource
          edu.mayo.bsi.ngsportal.server.GwtRpcDataSource

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, com.smartgwt.client.data.events.HasHandleErrorHandlers

public abstract class GwtRpcDataSource
extends com.smartgwt.client.data.DataSource

Data source with ability to communicate with server by GWT RPC.

SmartClient natively supports data protocol "clientCustom". This protocol means that communication with server should be implemented in transformRequest (DSRequest request) method. Here are a few things to note on transformRequest implementation:

• DSResponse object has to be created and processResponse (requestId, response) must be called to finish data request. requestId should be taken from original DSRequest.getRequestId ().
• "clientContext" attribute from DSRequest should be copied to DSResponse.
• In case of failure DSResponse should contain at least "status" attribute with error code (<0).
• In case of success DSResponse should contain at least "data" attribute with operation type specific data:
  • FETCH - ListGridRecord[] retrieved records.
  • ADD - ListGridRecord[] with single added record. Operation is called on every newly added record.
  • UPDATE - ListGridRecord[] with single updated record. Operation is called on every updated record.
  • REMOVE - ListGridRecord[] with single removed record. Operation is called on every removed record.

Version:

1.0

Author:

Aleksandras Novikovas, System Tier

Constructor Summary

GwtRpcDataSource()
Creates new data source which communicates with server by GWT RPC.

Method Summary

Methods inherited from class com.smartgwt.client.data.DataSource

addData, addData, addData, addField, addHandleErrorHandler, combineCriteria, convertRelativeDates, convertRelativeDates, copyRecord, copyRecords, create, downloadFile, downloadFile, exportClientData, exportData, exportData, fetchData, fetchData, filterData, filterData, get, get, getAddGlobalId, getAutoCacheAllData, getAutoConvertRelativeDates, getAutoDeriveTitles, getCacheAllData, getCacheData, getCacheMaxAge, getCallbackParam, getCanMultiSort, getChildrenField, getClientOnly, getCriteriaPolicy, getDataField, getDataFormat, getDataProtocol, getDataSource, getDataSource, getDataTransport, getDataURL, getDefaultParams, getDescriptionField, getDisplayValue, getDropExtraFields, getField, getFieldForDataPath, getFieldNames, getFieldNames, getFieldOperators, getFieldOperators, getFields, getFileURL, getGlobalNamespaces, getIconField, getInfoField, getInheritsFrom, getJsObj, getJsonPrefix, getJsonSuffix, getLegalChildTags, getOperationBindings, getOrCreateRef, getPluralTitle, getPreventHTTPCaching, getPrimaryKeyField, getPrimaryKeyFieldName, getQualifyColumnNames, getRecordXPath, getRequestProperties, getRequiredMessage, getResultBatchSize, getResultSetClass, getSchemaNamespace, getSendExtraFields, getServiceNamespace, getShowLocalFieldsOnly, getShowPrompt, getSortBy, getSortSpecifiers, getStrictSQLFiltering, getTagName, getTestData, getTitle, getTitleField, getTypeOperators, getUseFlatFields, getUseHttpProxy, getUseLocalValidators, getUseOfflineStorage, getUseParentFieldOrder, getUseTestDataFetch, getValidateRelatedRecords, getWillHandleAdvancedCriteria, hasAllData, invalidateCache, isCreated, load, load, performCustomOperation, processResponse, recordsFromXML, removeData, removeData, removeData, setAddGlobalId, setAutoCacheAllData, setAutoConvertRelativeDates, setAutoDeriveTitles, setCacheAllData, setCacheData, setCacheMaxAge, setCallbackParam, setCanMultiSort, setChildrenField, setClientOnly, setCriteriaPolicy, setDataField, setDataFormat, setDataProtocol, setDataTransport, setDataURL, setDefaultParams, setDescriptionField, setDropExtraFields, setEnumConstantProperty, setEnumOrdinalProperty, setEnumTranslateStrategy, setFields, setGlobalNamespaces, setIconField, setID, setInfoField, setInheritsFrom, setInheritsFrom, setJsonPrefix, setJsonSuffix, setOperationBindings, setPluralTitle, setPreventHTTPCaching, setQualifyColumnNames, setRecordName, setRecordXPath, setRequestProperties, setRequiredMessage, setResultBatchSize, setResultSetClass, setSendExtraFields, setServiceNamespace, setShowLocalFieldsOnly, setShowPrompt, setStrictSQLFiltering, setTagName, setTestData, setTitle, setTitleField, setTypeOperators, setUseFlatFields, setUseHttpProxy, setUseLocalValidators, setUseOfflineStorage, setUseParentFieldOrder, setUseTestDataFetch, setValidateRelatedRecords, setWillHandleAdvancedCriteria, setXmlNamespaces, supportsAdvancedCriteria, supportsTextMatchStyle, updateCaches, updateCaches, updateData, updateData, updateData, validateData, validateData, viewFile, viewFile, xmlSerialize, xmlSerialize, xmlSerialize, xmlSerialize, xmlSerialize

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

destroy, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getConfig, getHandlerCount, getID, getOrCreateJsObj, getRef, getScClassName, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setProperty, setProperty, setProperty, setProperty, setScClassName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

GwtRpcDataSource

public GwtRpcDataSource()

Creates new data source which communicates with server by GWT RPC. It is normal server side SmartClient data source with data protocol set to DSProtocol.CLIENTCUSTOM ("clientCustom" - natively supported by SmartClient but should be added to smartGWT) and with data format DSDataFormat.CUSTOM.