StarReports.idl

Go to the documentation of this file.

/**
 * @file     StarReports.idl
 * @brief    StaR reports API
 * @version  1
 */

#import <Users.idl>

module webadmin {

struct ReportConfig {
  boolean dailyEnabled;
  boolean weeklyEnabled;
  boolean monthlyEnabled;
  boolean onlineAccess;
};

struct StarReport {
  kerio::web::KId id;
  boolean enabled;
  Addressee addressee;

  UserReferenceList users;
  boolean allData;

  ReportConfig reportConfig;
};

typedef sequence<StarReport> StarReportList;

interface StarReports {

   /**
    * Returns list of StaR reports entries
    * @param list - list of entries
    * @param allUsers - Structure telling whether to send individual reports to each person reularly and wheter to allow them to see their reposrt online.
    * @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 StarReportList list, out ReportConfig allUsers);

   /**
    * Stores StaR reports entries
    *
    * @param errors - list of errors \n
    *          8002  Database error.   - "Unable to modify StaR report entry for '%1'." \n   
    *          8002  Database error.   - "Unable to create StaR report entry for '%1'." \n   
    *          8002  Database error.   - "Unable to remove StaR report entry for '%1'."   
    * @param reports - list of report configurations to be send regularly.
    * @param allUsers - Structure telling whether to send individual reports to each person reularly and wheter to allow them to see their reposrt online.
    * @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 StarReportList reports, in ReportConfig allUsers);

   /**
    * Immediately enqueues StaR report for send
    *
    * @param errors - list of errors \n
    *          1002  No such entity.   - "Unable to send weekly report, data for previous week are missing." \n
    *          1002  No such entity.   - "Unable to send monthly report, data for previous month are missing."
    * @param reports - list of addressees and types of the report 
    * @param language - language of the report
    * @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 send(out kerio::web::ErrorList errors, in StarReportList reports, in string language);
   
};

}; //webadmin