BulkConfiguration.idl

module bulkcfg {

    interface BulkConfiguration_1_0_1 {

        enumeration Status {
            UNKNOWN,            
            UPLOAD_FAILED,      
            RESTORE_PENDING,    
            RESTORE_OK,         
            RESTORE_FAILED      
        };

        void getStatus(out Status status, out time timeStamp);

        enumeration FilterType {
            WHITELIST,                  
            BLACKLIST                   
        };

        structure Filter {
            string name;                
            string displayName;         
            boolean noOverride;         
            boolean bulkOnly;           
            vector<string> ruleSpecs;   
        };

        structure FilterProfile {
            string name;                                
            string description;                         
            map<string,FilterType> filterNameToTypeMap; 
        };

        constant int SUCCESS                    = 0;    
        constant int ERR_FILTER_NAME_UNKNOWN    = 1;    
        constant int ERR_FILTER_TYPE_READONLY   = 2;    
        constant int ERR_PROFILE_ALREADY_EXISTS = 3;    
        constant int ERR_PROFILE_DOES_NOT_EXIST = 4;    
        constant int ERR_PROFILE_IS_DEFAULT     = 5;    
        constant int ERR_PROFILE_IS_BUILTIN     = 6;    
        constant int ERR_PROFILE_NAME_TOO_LONG  = 7;    
        constant int ERR_PROFILE_NAME_INVALID   = 8;    
        constant int ERR_PROFILE_TOO_MANY       = 9;    

        vector<Filter> getFilters();

        vector<FilterProfile> getFilterProfiles();

        int addFilterProfile(in FilterProfile profile);

        int modifyFilterProfile(in FilterProfile profile);

        int deleteFilterProfile(in string profileName);

        string getDefaultFilterProfileName();

        int selectDefaultFilterProfile(in string profileName);

    };

}