DataProviderActionCatalog.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-


namespace DataProvider {

public struct DataProviderAppInfo {

    string name;

    string display_name;

    string short_desc;

    string desc;

    string legal;

    *string group;


    *string scheme;


    data logo;

    string logo_file_name;


    string logo_mime_type;


    bool supports_events = False;


    bool supports_apis = False;


    bool supports_messages = False;


    bool supports_find = False;


    bool supports_find_single = False;


    bool supports_create = False;


    bool supports_upsert = False;


    bool supports_update = False;


    bool supports_delete = False;

    bool dynamic = False;

    bool hidden = False;

    *hash<auto> info;
};

const DPAT_EVENT = 1;

const DPAT_API = 2;

const DPAT_SEND_MESSAGE = 3;

const DPAT_FIND = 4;

const DPAT_FIND_SINGLE = 5;

const DPAT_CREATE = 6;

const DPAT_UPSERT = 7;

const DPAT_UPDATE = 8;

const DPAT_DELETE = 9;

const ActionCodeFlagMap = ...;
 

const AppActionFlags = ActionCodeFlagMap.values();

const ActionAttrMap = ...;
 

const ActionNameMap = ...;
 

public struct ActionOptionInfo {
    AbstractDataProviderType type;

    string display_name;

    string short_desc;

    string desc;

    *string group;

    bool required;


    *softlist<string> required_groups;

    *softlist<string> exclusive_with;

    auto default_value;

    bool sensitive;

    bool multiselect;

    *softlist<hash<AllowedValueInfo>> allowed_values;

    bool allowed_values_creatable;

    *softlist<hash<AllowedValueInfo>> element_allowed_values;

    bool element_allowed_values_creatable;

    auto example_value;

    *string validation_regex;


    *softlist<softstring> depends_on;


    *string ref_data;


    *string element_ref_data;


    *string default_ref_data;

    *string dynamic_type;

    bool preselected;

    bool readonly;

    bool disabled;


    *string loc;

    bool structural_determinate;

    *softlist<softstring> on_change;
};

public struct DataProviderPathVarInfo {
    string display_name;

    string short_desc;

    string desc;

    *string example_value;
};

public struct DataProviderActionInfo {
    string app;

    string action;

    *string group;


    *string subtype;


    string path;


    *hash<string, hash<DataProviderPathVarInfo>> path_vars;

    string display_name;

    string short_desc;

    string desc;


    int action_code;


    *string action_val;


    *string cls;

    *hash<auto> where_add;

    *hash<auto> options_add;

    *hash<auto> set_add;

    *hash<string, hash<ActionOptionInfo>> options;

    bool data_dependent_options = False;

    *AbstractDataProviderType output_type;

    bool has_dynamic_options;

    *code get_output_type;

    *code get_dynamic_options;

    *hash<DataProviderInfo> data_provider_info;
};

class DataProviderActionCatalog {
 
public:
        const RequiredAppKeys = ...;
 

        const RequiredActionKeys = ...;
 
 
protected:
        static Mutex lck();

        static hash<string, hash<DataProviderAppInfo>> appcache;

        static hash<string, hash<DataProviderActionInfo>> top_actionmap;

        static hash<string, hash<string, hash<DataProviderActionInfo>>> app_actionmap;

        static hash<string, list<hash<DataProviderActionInfo>>> smap;

        static hash<string, hash<string, bool>> resolve_output_types;

        static hash<string, hash<auto>> initmap;

        static hash<string, hash<string, code>> initactionmap;

        static hash<string, hash<string, bool>> appmodmap;

        const DefaultDescription = "";
 
public:


      static registerPendingApp(string app, code init);


      static registerPendingAppAction(string app, string action, code init);


      static registerApp(hash<DataProviderAppInfo> app);


      static *list<string> getModulePathsForApp(string app);


      static *hash<DataProviderAppInfo> deregisterDynamicApp(string name);


      static registerAction(hash<DataProviderActionInfo> action);


      static *int checkName(string name);


      static int compareActions(hash<DataProviderActionInfo> act0, hash<DataProviderActionInfo> act1);


      static int compareOptions(*hash<string, hash<ActionOptionInfo>> opt0, *hash<string, hash<ActionOptionInfo>> opt1);

      static int compareBaseTypes(*Type t0, *Type t1);


      static *list<hash<DataProviderAppInfo>> getAllAppsNoInit();


      static *list<hash<DataProviderAppInfo>> getAllApps();


      static *hash<DataProviderAppInfo> getApp(string app);


      static hash<DataProviderAppInfo> getAppEx(string app);


      static *list<hash<DataProviderAppInfo>> searchAppRegex(string regex_pattern, int regex_options = RE_Caseless);


      static *list<hash<DataProviderAppInfo>> searchAppSubstr(string substr, bool ignore_case = True);


      static *list<hash<DataProviderActionInfo>> getActionsForScheme(string scheme);


      static *hash<string, hash<DataProviderActionInfo>> getActionHash(string app);


      static *hash<string, hash<DataProviderActionInfo>> getActionHashEx(string app);


      static *list<hash<DataProviderActionInfo>> getActions(string app);


      static list<hash<DataProviderActionInfo>> getActionsEx(string app);


      static *list<hash<DataProviderActionInfo>> getAllActions();


      static *hash<DataProviderActionInfo> getAppAction(string app, string action);


      static hash<DataProviderActionInfo> getAppActionEx(string app, string action);


      static AbstractDataProvider getDataProviderForAction(hash<DataProviderActionInfo> action, *reference<hash<auto>> options);


      static *list<hash<DataProviderActionInfo>> searchAppActionRegex(string app, string regex_pattern, int regex_options = RE_Caseless);


      static *list<hash<DataProviderActionInfo>> searchAppActionSubstr(string app, string substr, bool ignore_case = True);


      static *list<hash<DataProviderActionInfo>> searchAppActionRegexEx(string app, string regex_pattern, int regex_options = RE_Caseless);


      static *list<hash<DataProviderActionInfo>> searchAppActionSubstrEx(string app, string substr, bool ignore_case = True);


      static *list<hash<DataProviderActionInfo>> searchActionRegex(string regex_pattern, int regex_options = RE_Caseless);


      static *list<hash<DataProviderActionInfo>> searchActionSubstr(string substr, bool ignore_case = True);

      static hash<string, hash<ActionOptionInfo>> getActionOptionFromFields(hash<auto> fields, *hash<auto> additional_fields);

      static hash<DataProviderActionInfo> checkAppActionOptions(string app, string action);

      static *AbstractDataProviderType getTypeForActionOptions(hash<auto> action);

      static *AbstractDataProviderType getTypeForActionOptions(hash<DataProviderActionInfo> action);

protected:
      static string normalizePath(string path);
public:
 

protected:
      static resolveOutputTypes();
public:
 

private:
      static *bool deregisterApp(string name);
public:
 

private:
      static *bool deregisterAppIntern(string name);
public:
 

protected:
      static doInit(hash<auto> h);
public:
 

protected:
      static doInit(code init);
public:
 
};
};
 
namespace Priv {
thread_local *string _mod_init_ctx;
};