webadmin::TrafficPolicy Interface Reference

import"TrafficPolicy.idl";

Public Member Functions
void	get (out TrafficRuleList list, out long totalItems)
void	set (out kerio::web::ErrorList errors, in TrafficRuleList rules, in TrafficRule defaultRule)
void	getCollisions (out CollisionList list)
void	getDefaultRule (out TrafficRule rule)
void	filterRules (out kerio::web::KIdList idList, in TrafficPolicyFilter condition)
void	normalizeTrafficEntity (out kerio::web::ErrorList errors, out TrafficEntity result, in TrafficEntity input)

Detailed Description

Manager for Traffic Policy

Member Function Documentation

void webadmin::TrafficPolicy::filterRules	(	out kerio::web::KIdList	idList,
		in TrafficPolicyFilter	condition
	)

Return all rules, that matches given criteria in time, when this method was called.

Parameters

list	- IDs of rules
condition	- Filter parameters. Empty parameter (0 for numbers) in condition means 'any'.

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." 8001 Invalid parameters. - "Invalid parameters."

void webadmin::TrafficPolicy::get	(	out TrafficRuleList	list,
		out long	totalItems
	)

Get the list of Traffic Policy rules

Parameters

list	- list of Traffic Policy rules
totalItems	- count of all rules in Traffic Policy

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::TrafficPolicy::getCollisions

(

out CollisionList

list

)

Return list of overlappped rules

Parameters

collisions

- list of collisions

Exceptions

kerio::web::ApiException

on error: -32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::TrafficPolicy::getDefaultRule

(

out TrafficRule

rule

)

Get properties of default rule

Parameters

rule	- properties of default rule

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

void webadmin::TrafficPolicy::normalizeTrafficEntity	(	out kerio::web::ErrorList	errors,
		out TrafficEntity	result,
		in TrafficEntity	input
	)

Normalize TrafficEntity.

Parameters

input

- TrafficEntity

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation." 8001 Invalid parameters. - "Invalid parameters."

void webadmin::TrafficPolicy::set	(	out kerio::web::ErrorList	errors,
		in TrafficRuleList	rules,
		in TrafficRule	defaultRule
	)

Stores the list of Traffic Policy rules

Parameters

errors	- list of errors 8002 Database error. - "Unable to modify rule '%1'." 8002 Database error. - "Unable to create rule '%1'." 8002 Database error. - "Unable to delete rule '%1'."
rules	- list of Traffic Policy rules
defaultRule	- properties of default rule

Exceptions

kerio::web::ApiException

-32001 Session expired. - "The user is not logged in." 1004 Access denied. - "Insufficient rights to perform the requested operation."

---

The documentation for this interface was generated from the following file:

• TrafficPolicy.idl