org.broadleafcommerce.openadmin.client.datasource

Class GwtRpcDataSource

java.lang.Object

com.smartgwt.client.core.BaseClass

com.smartgwt.client.data.DataSource

org.broadleafcommerce.openadmin.client.datasource.GwtRpcDataSource

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractDynamicDataSource

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 is 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

Field Summary

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

config, id, scClassName

Constructor Summary

Constructors

Constructor and Description
GwtRpcDataSource(String name) Creates new data source which communicates with server by GWT RPC.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	executeAdd(String requestId, com.smartgwt.client.data.DSRequest request, com.smartgwt.client.data.DSResponse response) Executed on ADD operation.
protected abstract void	executeFetch(String requestId, com.smartgwt.client.data.DSRequest request, com.smartgwt.client.data.DSResponse response) Executed on FETCH operation.
protected abstract void	executeRemove(String requestId, com.smartgwt.client.data.DSRequest request, com.smartgwt.client.data.DSResponse response) Executed on REMOVE operation.
protected abstract void	executeUpdate(String requestId, com.smartgwt.client.data.DSRequest request, com.smartgwt.client.data.DSResponse response) Executed on UPDATE operation.
protected Object	transformRequest(com.smartgwt.client.data.DSRequest request) Executes request to server.

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, getClientOnlyResponse, 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, onInit, 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, transformResponse, updateCaches, updateCaches, updateData, updateData, updateData, useOfflineResponse, validateData, validateData, viewFile, viewFile, xmlSerialize, xmlSerialize, xmlSerialize, xmlSerialize, xmlSerialize

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

destroy, doAddHandler, error, error, errorIfNotCreated, 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, setAttribute, setProperty, setProperty, setProperty, setProperty, setScClassName

Methods inherited from class java.lang.Object

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

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

fireEvent

Constructor Detail

GwtRpcDataSource

public GwtRpcDataSource(String name)

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.

Method Detail

transformRequest

protected Object transformRequest(com.smartgwt.client.data.DSRequest request)

Executes request to server.

Overrides:

transformRequest in class com.smartgwt.client.data.DataSource

Parameters:

request - DSRequest being processed.

Returns:

Object data from original request.

executeFetch

protected abstract void executeFetch(String requestId,
                com.smartgwt.client.data.DSRequest request,
                com.smartgwt.client.data.DSResponse response)

Executed on FETCH operation. processResponse (requestId, response) should be called when operation completes (either successful or failure).

Parameters:

requestId - String extracted from DSRequest.getRequestId ().

request - DSRequest being processed.

response - DSResponse. setData (list) should be called on successful execution of this method. setStatus (<0) should be called on failure.

executeAdd

protected abstract void executeAdd(String requestId,
              com.smartgwt.client.data.DSRequest request,
              com.smartgwt.client.data.DSResponse response)

Executed on ADD operation. processResponse (requestId, response) should be called when operation completes (either successful or failure).

Parameters:

requestId - String extracted from DSRequest.getRequestId ().

request - DSRequest being processed. request.getData () contains record should be added.

response - DSResponse. setData (list) should be called on successful execution of this method. Array should contain single element representing added row. setStatus (<0) should be called on failure.

executeUpdate

protected abstract void executeUpdate(String requestId,
                 com.smartgwt.client.data.DSRequest request,
                 com.smartgwt.client.data.DSResponse response)

Executed on UPDATE operation. processResponse (requestId, response) should be called when operation completes (either successful or failure).

Parameters:

requestId - String extracted from DSRequest.getRequestId ().

request - DSRequest being processed. request.getData () contains record should be updated.

response - DSResponse. setData (list) should be called on successful execution of this method. Array should contain single element representing updated row. setStatus (<0) should be called on failure.

executeRemove

protected abstract void executeRemove(String requestId,
                 com.smartgwt.client.data.DSRequest request,
                 com.smartgwt.client.data.DSResponse response)

Executed on REMOVE operation. processResponse (requestId, response) should be called when operation completes (either successful or failure).

Parameters:

requestId - String extracted from DSRequest.getRequestId ().

request - DSRequest being processed. request.getData () contains record should be removed.

response - DSResponse. setData (list) should be called on successful execution of this method. Array should contain single element representing removed row. setStatus (<0) should be called on failure.