<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.4//EN" "http://www.gnustep.org/gsdoc-1_0_4.dtd">
<gsdoc base="TypesAndConstants">
  <head>
    <title>Constants</title>
    <author name="Generated by _pbuild"></author>
  </head>
  <body>
    <front><contents /></front>
  <!--StartConstants-->
<!--StartGWSConstantsConstants-->
    <chapter>
      <heading>GWSConstants constants</heading>
      <p></p>
      <constant type="NSString* const" name="GWSErrorKey">
        <desc>
          Key for a local error returned in a result dictionary.
          <br /> If an error occurred at the local end while
          producing the result dictionary, the value for this
          key (and NSError, NSException, or NSString) will describe
          the nature of the problem.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSFaultKey">
        <desc>
          Key for a fault dictionary returned in a response
          dictionary. <br /> The value for this key is
          <code>nil</code> unless a wsdl <em>fault</em> was
          decoded into the dictionary.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSJSONResultKey">
        <desc>
          <em>Description forthcoming.</em>
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSMethodKey">
        <desc>
          Key for the method name in a request dictionary. <br />
          The value of this key is <code>nil</code> unless the
          dictionary was the result of decoding a request,
          in which case it is the name of the method/operation
          requested.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSOrderKey">
        <desc>
          Key for an ordering array in a request or response
          dictionary. <br /> If present in a decoded
          object, the value of this key is an NSMutableArray
          object containing the names of the parameters decoded.
          <br /> If present in a dictionary being encoded, this
          is an NSArray object specifying the order in which the
          members of the dictionary are to be encoded.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSParametersKey">
        <desc>
          Key for a parameters dictionary in a request or response
          dictionary. <br /> If present, the value of this
          key is an NSMutableDictionary containing the decoded
          parameters.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSRPCIDKey">
        <desc>
          Key for protocol request/response ID information stored
          in an RPC.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSRPCVersionKey">
        <desc>
          Key for protocol version information stored in an RPC
          request or response.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSRequestDataKey">
        <desc>
          Key for the data sent to a remote system to perform a
          GWSService RPC operation. <br /> This is present
          if debug was enabled for the service, but is omitted
          otherwise.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSResponseDataKey">
        <desc>
          Key for the data from a remote system returned in a
          result of a GWSService RPC made to a web services
          server. <br /> This is present if and debug was
          enabled for the service, but is omitted otherwise.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPArrayKey">
        <desc>
          If this key is present in a dictionary describing a value
          (one with a GWSSOAPValueKey present) where the value is
          actually an array of values, then the array contents
          are encoded as an xsd style array of items inside this
          element rather than as a sequence of values of the
          same type. The value of this key is used as the name for
          the array item elements (if the value is not a legal
          element name then the string 'item' is used).
<example>
 foo = {
   GWSSOAPValueKey = ("hello", "there");
   GWSSOAPArrayKey = val;
 };
 </example>
          would encode
          '&lt;foo&gt;&lt;val&gt;hello&lt;/val&gt;&lt;val&gt;there&lt;/val&gt;&lt;/foo&gt;' rather than the normal '&lt;foo&gt;hello&lt;/foo&gt;&lt;foo&gt;there&lt;/foo&gt;'
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPBodyEncodingStyleDocument">
        <desc>
          This means that the SOAP body is encoded in document
          style. <br /> Setting this value for the
          GWSSOAPBodyEncodingStyleKey in
          the parameters of a message being encoded has the same
          effect as calling
          <ref type="method" id="-setOperationStyle:" class="GWSSOAPCoder">[GWSSOAPCoder -setOperationStyle:]</ref> with an argument of GWSSOAPBodyEncodingStyleDocument.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPBodyEncodingStyleKey">
        <desc>
          Key for the encoding style to be used for the SOAP body.
          <br /> The value of this may be one of
          <list>
            <item>
              <ref type="constant" id="GWSSOAPBodyEncodingStyleDocument">GWSSOAPBodyEncodingStyleDocument</ref>
            </item>
            <item>
              <ref type="constant" id="GWSSOAPBodyEncodingStyleRPC">
                GWSSOAPBodyEncodingStyleRPC
              </ref>
            </item>
            <item>
              <ref type="constant" id="GWSSOAPBodyEncodingStyleWrapped">GWSSOAPBodyEncodingStyleWrapped</ref>
            </item>
          </list>
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPBodyEncodingStyleRPC">
        <desc>
          This means that the SOAP body is encoded in RPC style.
          <br /> Setting this value for the
          GWSSOAPBodyEncodingStyleKey in
          the parameters of a message being encoded has the same
          effect as calling
          <ref type="method" id="-setOperationStyle:" class="GWSSOAPCoder">[GWSSOAPCoder -setOperationStyle:]</ref> with an argument of GWSSOAPBodyEncodingStyleRPC.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPBodyEncodingStyleWrapped">
        <desc>
          This means that the SOAP body is encoded in wrapped
          style. <br /> Setting this value for the
          GWSSOAPBodyEncodingStyleKey in
          the parameters of a message being encoded has the same
          effect as calling
          <ref type="method" id="-setOperationStyle:" class="GWSSOAPCoder">[GWSSOAPCoder -setOperationStyle:]</ref> with an argument of GWSSOAPBodyEncodingStyleWrapped. <br /> NB. This encoding style is not yet implemented.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPMessageHeadersKey">
        <desc>
          Key for the header element for a soap message. <br /> You
          usually do not need to create this directly. <br />
          This is a dictionary of message parts (like the
          parameters dictionary itsself) which is used to
          specify for the contents of the Header. <br /> If you
          do not specify a value for this key, the coder will
          attempt to build a dictionary from any items in the
          parameters dictionary which are not used for the
          main message body. <br /> If no value is set for this
          key (and the dictionary can't be built from headers
          present in the main parameters dictionary), the
          header element is omitted.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPNamespaceNameKey">
        <desc>
          Key for the name to be used for the namespace of the
          current element (ie as the namespace prefix before
          the element name). <br /> For instance.
<example>
 foo = {
   GWSSOAPnamespaceNameKey = "xxx";
 };
 </example>
          means that the element is encoded as 'xxx:foo' rather
          than just 'foo'. <br /> This has a special meaning at
          the level of the SOAP Body, Fault, or Header dictionary.
          In these cases it does not set the namespace prefix for
          that element, but is instead used in conjunction with
          the GWSSOAPNamespaceURIKey to set up a namespace mapping
          in the SOAP Envelope.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPNamespaceURIKey">
        <desc>
          Key for the URI to be used as the default namespace for
          the current element (and all elements within it, unless
          overriden). <br /> As a special case at the SOAP
          Body, Fault, or Header level, if this key is used in
          conjunction with the GWSSOAPNamespaceNameKey, a
          mapping is set up in the SOAP Envelope to match the
          name to the URI. This behavior is in addition to the
          normal behavior of setting the default namespace.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPTypeKey">
        <desc>
          If this key is present in a dictionary describing a value
          (one with a GWSSOAPValueKey present) it is used to
          specify the type of the value, overriding any normal
          xsi:type=... setting inferred from the actual
          data type of the value.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPUseEncoded">
        <desc>
          Constant 'encoded' for Body/Header use. <br /> If
          data is 'encoded', each element of the data has a 'type'
          attribute which provides type information allowing
          the element contents to be be decoded.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPUseKey">
        <desc>
          Key for the 'use' style to be used for the SOAP Body,
          Header or Fault (depending on whether it is in the top
          level parameters dictionary or in the header
          parameters). <br /> The value of this key may be
          'literal' or 'encoded'.
          <ref type="constant" id="GWSSOAPUseEncoded">
            GWSSOAPUseEncoded
          </ref>
          or
          <ref type="constant" id="GWSSOAPUseLiteral">
            GWSSOAPUseLiteral
          </ref>
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPUseLiteral">
        <desc>
          Constant 'literal' for Body/Header use. <br /> If
          data is 'literal', the contents of elements are decoded
          by implicit type knowledge depending on the element name
          and its position within the XML document.
        </desc>
      </constant>
      <constant type="NSString* const" name="GWSSOAPValueKey">
        <desc>
          If this key is present in a dictionary, then instead of
          treating the dictionary as a complex type, the value
          referenced by this key is encoded, and other
          values in the dictionary (eg. GWSSOAPNamespaceURIKey)
          are used to modify the encoding of that value. <br /> eg.
<example>
 foo = {
   GWSSOAPValueKey = "hello";
   GWSSOAPNamespaceURIKey = "http://foo/xxx.xsd";
 };
 </example>
          would encode '&lt;foo
          "xmlns=http://foo/xxx.xsd"&gt;hello&lt;/foo&gt;'.
        </desc>
      </constant>
    </chapter>
<!--EndGWSConstantsConstants-->
<!--EndConstants-->
</body>
</gsdoc>
