public class WSRequest extends RPCRequest
All properties which are legal on RPCRequest are legal on a WSRequest, in addition to the properties listed here.
factoryCreated, factoryProperties| Constructor and Description |
|---|
WSRequest() |
WSRequest(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.core.client.JavaScriptObject |
getData()
Data to be serialized to XML to form the SOAP body.
|
java.util.Map |
getDataAsMap() |
java.util.Map |
getHeaderData()
Data to be serialized to form the SOAP headers, as a map from the header part name to the data.
|
static WSRequest |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.Boolean |
getUseFlatFields()
When
useFlatFields is set for a request to be sent to a WSDL web service, when creating the input XML message to send to the web service, properties in data will be used as the values for XML elements of the same name, at any level of nesting. |
java.lang.String |
getWsOperation()
Name of the web service operation to invoke.
|
void |
setData(com.google.gwt.core.client.JavaScriptObject data)
Data to be serialized to XML to form the SOAP body.
|
WSRequest |
setData(java.util.Map data)
Data to be serialized to XML to form the SOAP body.
|
void |
setHeaderData(java.util.Map headerData)
Data to be serialized to form the SOAP headers, as a map from the header part name to the data.
|
void |
setUseFlatFields(java.lang.Boolean useFlatFields)
When
useFlatFields is set for a request to be sent to a WSDL web service, when creating the input XML message to send to the web service, properties in data will be used as the values for XML elements of the same name, at any level of nesting. |
void |
setWsOperation(java.lang.String wsOperation)
Name of the web service operation to invoke.
|
void |
setXmlNamespaces(XmlNamespaces xmlNamespaces)
Optional object declaring namespace prefixes for use in evaluating the
resultType parameter of WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback), if resultType is an XPath. |
getActionURL, getAllowIE9Leak, getBypassCache, getCallbackParam, getContainsCredentials, getContentType, getDataAsString, getDownloadResult, getDownloadToNewWindow, getEvalResult, getHttpHeaders, getHttpMethod, getHttpProxyURL, getIgnoreTimeout, getMockMode, getOmitNullMapValuesInResponse, getParams, getPrompt, getPromptCursor, getPromptDelay, getPromptStyle, getSendNoQueue, getServerOutputAsString, getShowPrompt, getSuppressAutoDraw, getTimeout, getTransport, getUseCursorTracker, getUseHttpProxy, getUseSimpleHttp, getUseStrictJSON, getWillHandleError, getWithCredentials, setActionURL, setAllowIE9Leak, setBypassCache, setCallbackParam, setContainsCredentials, setContentType, setData, setData, setDownloadResult, setDownloadToNewWindow, setEvalResult, setEvalVars, setHttpHeaders, setHttpMethod, setHttpProxyURL, setIgnoreTimeout, setMockMode, setOmitNullMapValuesInResponse, setParams, setPrompt, setPromptCursor, setPromptDelay, setPromptStyle, setSendNoQueue, setServerOutputAsString, setShowPrompt, setSuppressAutoDraw, setTimeout, setTransport, setUseCursorTracker, setUseHttpProxy, setUseSimpleHttp, setUseStrictJSON, setWillHandleError, setWithCredentialsapplyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, 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, setFactoryCreatedpublic WSRequest()
public WSRequest(com.google.gwt.core.client.JavaScriptObject jsObj)
public static WSRequest getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setWsOperation(java.lang.String wsOperation)
wsOperation - wsOperation Default value is nullpublic java.lang.String getWsOperation()
public void setUseFlatFields(java.lang.Boolean useFlatFields)
useFlatFields is set for a request to be sent to a WSDL web service, when creating the input XML message to send to the web service, properties in data will be used as the values for XML elements of the same name, at any level of nesting. useFlatFields allows you to ignore gratuitous XML message structure, such as extra levels of nested elements, and provides some insulation against changes in the required structure of the input message.
For example, given this input message:
<FindServices> <searchFor>search text</searchFor> <Options> <caseSensitive>false</caseSensitive> </Options> <IncludeInSearch> <serviceName>true</serviceName> <documentation>true</documentation> <keywords>true</keywords> </IncludeInSearch> </FindServices>If
useFlatFields were not set, in order to fill out this message correctly, request.data would need to be: { searchFor: "search text", Options : { caseSensitive: false, }, IncludeInSearch : { serviceName: true, documentation : true, keywords : true } } However if useFlatFields were set, request.data could be just: { searchFor: "search text", caseSensitive: false, serviceName: true, documentation : true, keywords : true } useFlatFields is often set when the input data comes from a DynamicForm to avoid the cumbersome and fragile process of mapping input fields to an XML structure. useFlatFields can also be set to cause all dsRequests of a particular type to useFlatFields automatically.
For DataBoundComponent, useFlatFields can be set use "flattened" binding to fields of a WSDL message or XML Schema.
Note that useFlatFields is not generally recommended for use with XML input messages where multiple simple type fields exist with the same name, however if used in this way, the first field to use a given name wins. "first" means the first field encountered in a depth first search. "wins" means only the first field will be populated in the generated XML message.
useFlatFields - useFlatFields Default value is nullpublic java.lang.Boolean getUseFlatFields()
useFlatFields is set for a request to be sent to a WSDL web service, when creating the input XML message to send to the web service, properties in data will be used as the values for XML elements of the same name, at any level of nesting. useFlatFields allows you to ignore gratuitous XML message structure, such as extra levels of nested elements, and provides some insulation against changes in the required structure of the input message.
For example, given this input message:
<FindServices> <searchFor>search text</searchFor> <Options> <caseSensitive>false</caseSensitive> </Options> <IncludeInSearch> <serviceName>true</serviceName> <documentation>true</documentation> <keywords>true</keywords> </IncludeInSearch> </FindServices>If
useFlatFields were not set, in order to fill out this message correctly, request.data would need to be: { searchFor: "search text", Options : { caseSensitive: false, }, IncludeInSearch : { serviceName: true, documentation : true, keywords : true } } However if useFlatFields were set, request.data could be just: { searchFor: "search text", caseSensitive: false, serviceName: true, documentation : true, keywords : true } useFlatFields is often set when the input data comes from a DynamicForm to avoid the cumbersome and fragile process of mapping input fields to an XML structure. useFlatFields can also be set to cause all dsRequests of a particular type to useFlatFields automatically.
For DataBoundComponent, useFlatFields can be set use "flattened" binding to fields of a WSDL message or XML Schema.
Note that useFlatFields is not generally recommended for use with XML input messages where multiple simple type fields exist with the same name, however if used in this way, the first field to use a given name wins. "first" means the first field encountered in a depth first search. "wins" means only the first field will be populated in the generated XML message.
public void setHeaderData(java.util.Map headerData)
<soap:header part="SessionHeader" message="tns:HeaderMessage"/> <soap:header part="CallOptions" message="tns:HeaderMessage/>
headerData like this might be provided: dsRequest.headerData = { SessionHeader : data CallOptions : data }; The provided data will be serialized to XML by the com.smartgwt.client.data.WebService#getInputHeaderSchema via DataSource.xmlSerialize(com.google.gwt.core.client.JavaScriptObject)headerData - headerData Default value is nullpublic java.util.Map getHeaderData()
<soap:header part="SessionHeader" message="tns:HeaderMessage"/> <soap:header part="CallOptions" message="tns:HeaderMessage/>
headerData like this might be provided: dsRequest.headerData = { SessionHeader : data CallOptions : data }; The provided data will be serialized to XML by the com.smartgwt.client.data.WebService#getInputHeaderSchema via DataSource.xmlSerialize(com.google.gwt.core.client.JavaScriptObject)public void setData(com.google.gwt.core.client.JavaScriptObject data)
setData in class RPCRequestdata - data Default value is nullRPCResponse.getDataAsMap(),
RPCResponse.getDataAsObject(),
RPCResponse.getDataAsString()public WSRequest setData(java.util.Map data)
setData in class RPCRequestdata - data Default value is nullWSRequest instance, for chaining
setter callscom.smartgwt.client.rpc.RPCResponse#setDatapublic com.google.gwt.core.client.JavaScriptObject getData()
getData in class RPCRequestRPCResponse.getDataAsMap(),
RPCResponse.getDataAsObject(),
RPCResponse.getDataAsString()public java.util.Map getDataAsMap()
public void setXmlNamespaces(XmlNamespaces xmlNamespaces)
resultType parameter of WebService.callOperation(java.lang.String, java.util.Map, java.lang.String, com.smartgwt.client.data.WebServiceCallback), if resultType is an XPath. Format is identical to xmlNamespaces, and default namespaces bindings are also identical.
xmlNamespaces - xmlNamespaces Default value is null