dojox/wire/ml/Service.js

• Provides:

  • dojox.wire.ml.JsonHandler

• Requires:

  • dijit._Widget in common
  • dojox.xml.parser in common
  • dojox.wire._base in common
  • dojox.wire.ml.util in common

• dojox.wire.ml.Service

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Widget: (call)
  • summary

    A widget for a service

  • description

    This widget represents a service defined by a service description
    specified with 'url' attribute.
    If 'serviceType' and 'serviceUrl' attributes are specified, 'url'
    attribute can be omitted.

• dojox.wire.ml.Service.url

  • type

    A

  • summary

    URL to a service description

• dojox.wire.ml.Service.serviceUrl

  • type

    A

  • summary

    URL to a service

• dojox.wire.ml.Service.serviceType

  • type

    A

  • summary

    service type

• dojox.wire.ml.Service.handlerClass

  • type

    A

  • summary

    service handler class name

• dojox.wire.ml.Service.preventCache

  • type

    Object

• dojox.wire.ml.Service.postCreate

  • summary

    Call _createHandler()

  • description

    See _createHandler().

  • type

    Function

• dojox.wire.ml.Service.handler

  • type

    Object

• dojox.wire.ml.Service._handlerClasses

  • type

    Object

• dojox.wire.ml.Service._handlerClasses.TEXT

  • type

    String

• dojox.wire.ml.Service._handlerClasses.XML

  • type

    String

• dojox.wire.ml.Service._handlerClasses.JSON

  • type

    String

• dojox.wire.ml.Service._handlerClasses.JSON-RPC

  • type

    String

• dojox.wire.ml.Service._createHandler

  • returns

    null|Object

  • summary

    Create a service handler
    desription:
    A service handler class is determined by:
    1. 'handlerClass' attribute
    2. 'serviceType' attribute
    3. 'serviceType' property in a service description

  • return_summary

    A service handler

  • type

    Function

• dojox.wire.ml.Service.callMethod

  • parameters:
    • method: (typeof A)

      method name

    • parameters: (typeof An)

      array parameters

  • summary

    Call a service method with parameters

  • type

    Function

• dojox.wire.ml.RestHandler

  • type

    Function

  • summary

    A REST service handler

  • description

    This class serves as a base REST service.
    Sub-classes may override _getContent() and _getResult() to handle
    specific content types.

• dojox.wire.ml.RestHandler.contentType

  • type

    String

• dojox.wire.ml.RestHandler.handleAs

  • type

    String

• dojox.wire.ml.RestHandler.bind

  • parameters:
    • method: (typeof A)

      method name

    • parameters: (typeof An)

      array of parameters

    • deferred: (typeof 'Deferred')
    • url: (typeof A)

      URL for the method

  • summary

    Call a service method with parameters.

  • description

    A service is called with a URL generated by _getUrl() and
    an HTTP method specified with 'method'.
    For "POST" and "PUT", a content is generated by _getContent().
    When data is loaded, _getResult() is used to pass the result to
    Deferred.callback().

  • type

    Function

• dojox.wire.ml.RestHandler._getUrl

  • parameters:
    • method: (typeof String)

      A method name

    • parameters: (typeof Array)

      An array of parameters

    • url: (typeof String)

      A base URL

  • returns

    String

  • summary

    Generate a URL

  • description

    If 'method' is "GET" or "DELETE", a query string is generated
    from a query object specified to the first parameter in
    'parameters' and appended to 'url'.
    If 'url' contains variable seguments ("{parameter_name}"),
    they are replaced with corresponding parameter values, instead.

  • return_summary

    A URL

  • type

    Function

• dojox.wire.ml.RestHandler._getContent

  • parameters:
    • method: (typeof String)

      A method name

    • parameters: (typeof Array)

      An array of parameters

  • returns

    anything|null

  • summary

    Generate a request content

  • description

    If 'method' is "POST" or "PUT", the first parameter in
    'parameters' is returned.

  • return_summary

    A request content

  • type

    Function

• dojox.wire.ml.RestHandler._getResult

  • parameters:
    • data: (typeof anything)

      A response data returned by a service

  • returns

    anything

  • summary

    Extract a result

  • description

    A response data is returned as is.

  • return_summary

    A result object

  • type

    Function

• dojox.wire.ml.XmlHandler

  • type

    Function

  • chains:
    • dojox.wire.ml.RestHandler: (prototype)
    • dojox.wire.ml.RestHandler: (call)
  • summary

    A REST service handler for XML

  • description

    This class provides XML handling for a REST service.

• dojox.wire.ml.XmlHandler.contentType

  • type

    String

• dojox.wire.ml.XmlHandler.handleAs

  • type

    String

• dojox.wire.ml.XmlHandler._getContent

  • parameters:
    • method: (typeof String)

      A method name

    • parameters: (typeof Array)

      An array of parameters

  • description

    If 'method' is "POST" or "PUT", the first parameter in
    'parameters' is used to generate an XML content.

  • return_summary

    A request content

  • type

    Function

• dojox.wire.ml.XmlHandler._getResult

  • parameters:
    • data: (typeof Document)

      A response data returned by a service

  • summary

    Extract a result

  • description

    A response data (XML Document) is returned wrapped with
    XmlElement.

  • return_summary

    A result object

  • type

    Function

• dojox.wire.ml.JsonHandler

  • type

    Function

  • chains:
    • dojox.wire.ml.RestHandler: (prototype)
    • dojox.wire.ml.RestHandler: (call)
  • summary

    A REST service handler for JSON

  • description

    This class provides JSON handling for a REST service.

• dojox.wire.ml.JsonHandler.contentType

  • type

    String

• dojox.wire.ml.JsonHandler.handleAs

  • type

    String

• dojox.wire.ml.JsonHandler.headers

  • type

    Object

• dojox.wire.ml.JsonHandler.headers.Accept

  • type

    String

• dojox.wire.ml.JsonHandler._getContent

  • parameters:
    • method: (typeof String)

      A method name

    • parameters: (typeof Array)

      An array of parameters

  • returns

    String

  • summary

    Generate a request content

  • description

    If 'method' is "POST" or "PUT", the first parameter in
    'parameter' is used to generate a JSON content.

  • return_summary

    A request content

  • type

    Function

• dojox.wire.ml

  • type

    Object

• dojox.wire

  • type

    Object

• dojox

  • type

    Object