SoapDataProvider.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
// minimum required Qore version
// assume local scope for variables, do not use "$" signs
// require type definitions everywhere
// strict argument handling
// enable all warnings
 
namespace SoapDataProvider {
class SoapDataProvider : public AbstractDataProvider {
 
public:
        WebService webservice;
 
        *SoapClient soapclient;
 
        const ProviderInfo = <DataProviderInfo>{
            "type": "SoapDataProvider",
            "supports_read": False,
            "supports_create": False,
            "supports_update": False,
            "supports_upsert": False,
            "supports_delete": False,
            "supports_native_search": False,
            "supports_bulk_create": False,
            "supports_bulk_upsert": False,
            "supports_children": True,
            "constructor_options": ConstructorOptions,
            "search_options": NOTHING,
            "create_options": NOTHING,
            "upsert_options": NOTHING,
            "transaction_management": False,
        };
 
        const ConstructorOptions = {
            "schema": <DataProviderOptionInfo>{
                "type": (
                    AbstractDataProviderType::get(StringType),
                    AbstractDataProviderType::get(new Type("WebService")),
                ),
                "desc": "the SOAP schema object (WebService) or source URL for the WSDL",
                "required": True,
            },
            "soapclient": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(new Type("SoapClient")),
                "desc": "the SoapClient object",
            },
            "url": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "the URL to the SOAP server; overrides any URL in the schema or in any SoapClient object "
                    "passed as an option",
            },
            "soapclient_options": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(AutoHashType),
                "desc": "options to the SoapClient constructor; only used if a SoapClient object is created for a "
                    "call",
            },
        };
 
protected:
        hash<auto> path_tree;
 
public:
 
    constructor(WebService webservice, *SoapClient soapclient);
 
 
    constructor(*hash<auto> options);
 
 
    string getName();
 
 
protected:
     checkSoapClient(SoapClient soap);
public:
 
 
 
protected:
     *list<string> getChildProviderNamesImpl();
public:
 
 
 
protected:
     *AbstractDataProvider getChildProviderImpl(string name);
public:
 
 
protected:
     hash<DataProviderInfo> getStaticInfoImpl();
public:
 
};
};