|
API Reference
There is AJAX WebService Component reference, that describes all public methods and properties for our component, including
The reference is organized on top-down order: the class that might use certain sub-class defined before that sub-class description. WSClientParametersThe WSClientParameters class contains all request parameters for WebService method invocation. You need to fill these parameters before calling WebService operation (if any input parameters are necessary). The following list of methods are available: AddThe method ‘add’ inserts the new input parameter pair to WSClientParameters object instance. It have no any checks to proper names relevant to schema; you need to validate proper parameter names with your code, or you need to use WSDL-based validation (for document-style calls) and related classes DocumentElement and SchemaElement as it described in tutorial.
Inputs:
Outputs:
toXmlThe method toXml serializes content of corresponding instance of WSClientParameters to XML nodes. These nodes will be used to build envelope in SOAP request. Usually you don’t need to call this method directly except debug purposes. Inputs:
Outputs:
getParametersThe method getParameters returns request parameters as named Array object. It can be useful when you wont change some of the request values. Inputs:
Outputs:
getXmlThe getXML method works in the same manner as to toXml method; but it allow to serialize instance of WSClientParameters object limited to specific complex or array type. Inputs:
Outputs:
WSClientThe WSClient class is main class for WebService invocations. It provides all useful methods to invoke WebServices. InvokeThe invoke method is main way to call certain WebService operation, with input parameters already filled and validated before call this method, and creates response. Inputs:
Outputs:
WSDLInfoThe WSDLInfo class holds full meta-information about WebService that WSDL could provide. You need instance for this class to invoke any methods. loadWSDLThe loadWsdl method load WSDL definition from specific URL, parses, and collects all information from this definition. There is mandatory method to be used before using all other methods. Inputs:
Outputs:
getServicesThe getServices method provides collection of all services from WSDL. Inputs:
Outputs:
getSchemaElementsThe getSchemaElements method provides collection of all XSD elements from WSDL Types sections. Inputs:
Outputs:
getWSDLThe getWSDL method returns reference to WSDL document. Inputs:
Outputs:
parseWSDLThe parseWsdl method works in the same manner as loadWSDL method but uses XML structure instead of URL. It parses WSDL structure and fills it into WSDLInfo instance. Inputs:
Outputs:
findOperationThe findOperation method finds operation from WSDLInfo current instance. Inputs:
Outputs:
schemaElementsThe schemaElements collection that holds all schema elements for all document style operations defined in WSDL. It contains definituions for all complex types and arrays in WSDL (all xsd:type definitions). This collection contains SchemaElement objects and is available as loadWsdl or parseWsdl methods invoked. WsdlServiceThe WsdlService class holds information about certain service from WSDL definition. The information is collected from WSDL and WSDLInfo class responsible to create and fill proper data. getNameThe getName method returns service name defined in WSDL. Inputs:
Outputs:
getPortsThe getPorts method provides collection of ports for service. Inputs:
Outputs:
WsdlPortThe WsdlPort class holds information for certain port of service. The information is collected from WSDL and WSDLInfo class responsible to create and fill proper data. getNameThe getName method returns port name defined in WSDL. Inputs:
Outputs:
getWsdlPortTypeThe getWsdlPortType method returns port type defined in WSDL. Inputs:
Outputs:
getAddressLocationThe getAddressLocation method returns exact endpoint URL address defined in WSDL for this port. Inputs:
Outputs:
WsdlTypeThe WsdlType class holds port type information. The information is collected from WSDL and WSDLInfo class responsible to create and fill proper data. getNameThe getName method returns port name defined in WSDL. Inputs:
Outputs:
getOperationsThe getOperations method provides collection of operations for specific port, related to specific port type. Inputs:
Outputs:
findOperationThe findOperation method returns certain operation in port type, or NULL if no operation present. Inputs:
Outputs:
WsdlOperationThe WsdlOperation class holds information about certain operation from WSDL. The information is collected from WSDL and WSDLInfo class responsible to create and fill proper data. getNameThe getName method returns operation name defined in WSDL. Inputs:
Outputs:
getInputThe getInput method returns input parameters defined in WSDL. Inputs:
Outputs:
getOutputThe getOutput method returns input parameters defined in WSDL. Inputs:
Outputs:
getInputPartsThe getInputParts method returns input parts (parameters) defined in WSDL. Inputs:
Outputs:
getOutPutPartsThe getOutPutParts method returns output parts (parameters) defined in WSDL. Inputs:
Outputs:
getInputParameterMapThe getInputParameterMap method creates WSClientParameters instance with empty values for each input parameters. Inputs:
Outputs:
InvokeThe invoke method provides generic way to call certain WebService operation, with input parameters filled. The invoke method is main way to call certain WebService operation, with input parameters already filled and validated before call this method, and creates response. Inputs:
Outputs:
WsdlInputThe WsdlInput class holds meta-information about input parameters for operation. The information is collected from WSDL and WSDLInfo class responsible to create and fill proper data. getNameThe getName method returns input parameter name defined in WSDL. Inputs:
Outputs:
getMessageThe getMessage method returns input parameters details defined in WSDL. Inputs:
Outputs:
WsdlOutputThe WsdlOutput class holds meta-information about response structure for operation. The information is collected from WSDL and WSDLInfo class responsible to create and fill proper data. getNameThe getName method returns output value name defined in WSDL. Inputs:
Outputs:
getMessageThe getMessage method returns output value details defined in WSDL. Inputs:
Outputs:
WsdlMessageThe WsdlMessage class holds information about proper types (both input parameters and output values) for input/output. It declares single parameter/output value information. The information is collected from WSDL and WSDLInfo class responsible to create and fill proper data. getNameThe getName method returns message name defined in WSDL. Inputs:
Outputs:
getPartsThe getParts method returns parts of message defined in WSDL. Inputs:
Outputs:
WsdlPartThe WsdlPart this class holds information about certain part for input/output message. The information is collected from WSDL and WSDLInfo class responsible to create and fill proper data. getNameThe getName method returns part name defined in WSDL. Inputs:
Outputs:
getPartTypeThe getPartType method returns part type defined in WSDL. Inputs:
Outputs:
isDocumentStyleThe isDocumentStyle method returns information in which forms (RPC or document-style) were used to define this part of message. Inputs:
Outputs:
getDocumentStyleElementNodeThe getDocumentStyleElementNode method returns XML element contains part definition, if document style were used. Inputs:
Outputs:
getDocumentStyleElementThe getDocumentStyleElement method returns DocumentStyle element contains part definition, if document style were used. This method is pretty similar to getDocumentStyleElementNode but uses our wrapper instead of clean XML element. Inputs:
Outputs:
DocumentElementThe DocumentElement class holds information about message for input/output, in case document-style calls were defined in WSDL. The information is collected from WSDL and WSDLInfo class responsible to create and fill proper data. getNameThe getName method returns element name. Inputs:
Outputs:
parseElementThe parseElement provides analysis of document style definition in WSDL for this message part. Instead of all other data, you need invoke method this first to get an access to document-style definitions. All other data is being parsed on the fly, but not document style definitions as it is time consuming operation (it able to have rich XSD definitions here, with extensions, 3rd party namespaces and includes of 3rd party XSDs). Inputs:
Outputs:
getChildrenThe getChildren method returns sub-definitions for current element. With these methods you able to navigate for document style definitions for every element. Inputs:
Outputs:
SchemaElementThe SchemaElement class holds information about all wsdl:type schema elements. These elements are collected and maintained by WSDLInfo and collection schemaElements in WSDLInfo object. getNameThe getName method returns type name. Inputs:
Outputs:
fillThe fill method parses current schema type and finds all sub-elements recursively. So by calling this method you’ll initialize schema definition for this type and for all sub-types. Inputs:
Outputs:
getXmlElementThe getXmlElement method returns XML node describes this XSD type. Inputs:
Outputs:
getNamespaceThe getNamespace method returns custom namespace defined for this type, if exists. Inputs:
Outputs:
|
AJAX WebService Component:
Overview
Download
License
Architecture
Tutorial
API
Support
WebService Explorer Overview Download License Guide Support |
Copyright © SCAND LLC, 2007. All Rights Reserved. |