Server.idl

Go to the documentation of this file.

/**
 * @file     Server.idl
 * @brief    Server properties
 * @version  2
 */

#import <kerio/web/idl/SharedStructures.idl>

module webadmin {

enum ServerOs {
    Windows,
    Linux
};

/**
 * Available entities, entity prefix due to name collision
enum Entity {
   EntityUser,          ///< User Entity
   EntityAlias,         ///< Alias Entity
   EntityGroup,         ///< Group Entity
   EntityMailingList,      ///< Mailing List Entity
   EntityResource,         ///< Resource Scheduling Entity
   EntityTimeRange,     ///< Time Range Entity
   EntityTimeRangeGroup,   ///< Time Range Group Entity
   EntityIpAddress,     ///< Ip Address Entity
   EntityIpAddressGroup,   ///< Ip Address Group Entity
   EntityService,       ///< Service Entity
   EntityDomain
};
 */

/**
 * Restriction Items
 */
struct RestrictionTuple {
   string name; // was of type kerio::web::ItemName
   kerio::web::RestrictionKind kind;
   kerio::web::StringList values;
};

/**
 * Restriction tuple for 1 entity
 */
typedef sequence<RestrictionTuple> RestrictionTupleList;

/**
 * Entity name restriction definition
 */
struct Restriction {
   string entityName;            ///< was of type Entity
   RestrictionTupleList tuples;  ///< Restriction tuples
};

/**
 * List of restrictions
 */
typedef sequence<Restriction> RestrictionList;


interface Server {
    /** 
    * @param os - engine OS. I would like to enumerate where client depends on engine OS but such list will become obsolete soon 
    */
    void getOs(out ServerOs os);

   void getRestrictionList(out RestrictionList restrictions);
};

}; //webadmin