Accounting.idl

Go to the documentation of this file.

/**
 * @file      Accounting.idl
 * @brief     Accounting tab API (Statistics / Quota, Exceptions)
 * @version   2
 */

#import <kerio/web/idl/TimeRanges.idl>
#import <common.idl>
#import <Users.idl>
 
module webadmin {

enum UserFormatType {
   UserFormatFL,
   UserFormatFLU,
   UserFormatFLD,
   UserFormatLF,
   UserFormatLFU,
   UserFormatLFD
};

struct AccountingConfig {
   boolean         enabled;
   boolean         activityLogEnabled;
   long            maxAge;
   UserFormatType  userFormat;

   UserReferenceList   gatheredGroups;
   
   kerio::web::Day startWeekDay;   ///< @see kerio::web::TimeRangeManager
   long            startMonthDay;  ///< 1..28

   string          starReportLanguage;
   
   OptionalIdReference validTimeRange;
   OptionalIdReference ipAddressGroup;
   UserReferenceList   userExceptions;
   OptionalIdReference urlGroup;
};

interface Accounting {

   /**
    * Returns Accounting configuration
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied    - "Insufficient rights to perform the requested operation."
    */
   void get(out AccountingConfig config);

   /**
    * Stores Accounting configuration
    * @throws kerio::web::ApiException \n
    *         -32001 Session expired. - "The user is not logged in." \n
    *          1004  Access denied    - "Insufficient rights to perform the requested operation." 
    */
   void set(out kerio::web::ErrorList errors, in AccountingConfig config);

};

};//webadmin