Simias::Policy::SyncInterval Class Reference

Implements the synchronization interval policy. More...

Collaboration diagram for Simias::Policy::SyncInterval:

Collaboration graph
[legend]

List of all members.

Static Public Member Functions

static void Create (string domainID, int interval)
 Creates a system wide sync interval policy.
static void Create (Member member, int interval)
 Creates a sync interval policy for the specified member.
static void Create (Collection collection, int interval)
 Creates a sync interval policy for the specified collection.
static void Create (int interval)
 Creates a sync interval policy for the current user on the current machine.
static void Delete (string domainID)
 Deletes a system wide sync interval policy.
static void Delete (Member member)
 Deletes a sync interval policy for the specified member.
static void Delete (Collection collection)
 Deletes a sync interval policy for the specified collection.
static void Delete ()
 Deletes a sync interval policy for the current user on the current machine.
static SyncInterval Get (Member member)
 Gets the aggregate sync interval for the specified member.
static SyncInterval Get (Member member, Collection collection)
 Gets the aggregate sync interval for the specified member and collection.
static SyncInterval Get (Collection collection)
 Gets the aggregate sync interval for the specified member and collection.
static int GetInterval (string domainID)
 Gets the interval associated with the specified domain.
static int GetInterval (Member member)
 Gets the sync interval associated with the specified member.
static int GetInterval (Collection collection)
 Gets the sync interval associated with the specified collection.
static int GetInterval ()
 Gets the sync interval associated with the current user on the current machine.
static void Set (string domainID, int interval)
 Sets the sync interval associated with the specified domain.
static void Set (Member member, int interval)
 Sets the sync interval associated with the specified member.
static void Set (Collection collection, int interval)
 Sets the sync interval associated with the specified collection.
static void Set (int interval)
 Sets the sync interval associated with the current user on the current machine.

Static Public Attributes

static readonly string SyncIntervalPolicyID = "bee14cb3-f323-40cb-a948-44a0c3275f2f"
 Well known name for the sync interval policy.
static readonly string SyncIntervalShortDescription = "Sync Interval Setting"
 Well known name for the sync interval policy description.
static readonly string IntervalTag = "Interval"
 Tag used to lookup and store the interval value on the policy.
static readonly int InfiniteSyncInterval = -1
 Implies to never synchronize.

Properties

int Interval [get]
 Gets the sync interval in seconds. If the policy is aggregated, the largest sync interval will be returned.

Detailed Description

Implements the synchronization interval policy.

Member Function Documentation

static void Simias::Policy::SyncInterval::Create ( string  domainID,
int  interval 
) [inline, static]

Creates a system wide sync interval policy.

Parameters:
domainID Domain that the interval will be associated with.
interval Sync interval in seconds that all users in the domain will be set to.

static void Simias::Policy::SyncInterval::Create ( Member  member,
int  interval 
) [inline, static]

Creates a sync interval policy for the specified member.

Parameters:
member Member that the filter will be associated with.
interval Sync interval in seconds that all users in the domain will be set to.

static void Simias::Policy::SyncInterval::Create ( Collection  collection,
int  interval 
) [inline, static]

Creates a sync interval policy for the specified collection.

Parameters:
collection Collection that the filter will be associated with.
interval Sync interval in seconds that all users in the domain will be set to.

static void Simias::Policy::SyncInterval::Create ( int  interval  )  [inline, static]

Creates a sync interval policy for the current user on the current machine.

Parameters:
interval Sync interval in seconds that all users in the domain will be set to.

static void Simias::Policy::SyncInterval::Delete ( string  domainID  )  [inline, static]

Deletes a system wide sync interval policy.

Parameters:
domainID Domain that the interval will be associated with.

static void Simias::Policy::SyncInterval::Delete ( Member  member  )  [inline, static]

Deletes a sync interval policy for the specified member.

Parameters:
member Member that the filter will be associated with.

static void Simias::Policy::SyncInterval::Delete ( Collection  collection  )  [inline, static]

Deletes a sync interval policy for the specified collection.

Parameters:
collection Collection that the filter will be associated with.

static void Simias::Policy::SyncInterval::Delete (  )  [inline, static]

Deletes a sync interval policy for the current user on the current machine.

static SyncInterval Simias::Policy::SyncInterval::Get ( Member  member  )  [inline, static]

Gets the aggregate sync interval for the specified member.

Parameters:
member Member that policy is associated with.
Returns:
A SyncInterval object that contains the policy for the specified member.

static SyncInterval Simias::Policy::SyncInterval::Get ( Member  member,
Collection  collection 
) [inline, static]

Gets the aggregate sync interval for the specified member and collection.

Parameters:
member Member that policy is associated with.
collection Collection to add to the aggregate policy.
Returns:
A SyncInterval object that contains the policy for the specified member.

static SyncInterval Simias::Policy::SyncInterval::Get ( Collection  collection  )  [inline, static]

Gets the aggregate sync interval for the specified member and collection.

Parameters:
collection Collection to add to the aggregate policy.
Returns:
A SyncInterval object that contains the policy for the specified member.

static int Simias::Policy::SyncInterval::GetInterval ( string  domainID  )  [inline, static]

Gets the interval associated with the specified domain.

Parameters:
domainID Domain that the interval is associated with.
Returns:
The sync interval that all users in the domain are limited to.

static int Simias::Policy::SyncInterval::GetInterval ( Member  member  )  [inline, static]

Gets the sync interval associated with the specified member.

Parameters:
member Member that the interval is associated with.
Returns:
The sync interval that the member is limited to.

static int Simias::Policy::SyncInterval::GetInterval ( Collection  collection  )  [inline, static]

Gets the sync interval associated with the specified collection.

Parameters:
collection Collection that the interval is associated with.
Returns:
The sync interval that all users in the collection are limited to.

static int Simias::Policy::SyncInterval::GetInterval (  )  [inline, static]

Gets the sync interval associated with the current user on the current machine.

Returns:
The sync interval that the current user is limited to.

static void Simias::Policy::SyncInterval::Set ( string  domainID,
int  interval 
) [inline, static]

Sets the sync interval associated with the specified domain.

Parameters:
domainID Domain that the interval is associated with.
interval Sync interval in seconds that all users in the domain will be set to.

static void Simias::Policy::SyncInterval::Set ( Member  member,
int  interval 
) [inline, static]

Sets the sync interval associated with the specified member.

Parameters:
member Member that the filter is associated with.
interval Sync interval in seconds that the associated member will be set to.

static void Simias::Policy::SyncInterval::Set ( Collection  collection,
int  interval 
) [inline, static]

Sets the sync interval associated with the specified collection.

Parameters:
collection Collection that the policy is associated with.
interval Sync interval in seconds that the collection will be set to.

static void Simias::Policy::SyncInterval::Set ( int  interval  )  [inline, static]

Sets the sync interval associated with the current user on the current machine.

Parameters:
interval Sync interval in seconds that the current user will be set to.

Member Data Documentation

readonly string Simias::Policy::SyncInterval::SyncIntervalPolicyID = "bee14cb3-f323-40cb-a948-44a0c3275f2f" [static]

Well known name for the sync interval policy.

readonly string Simias::Policy::SyncInterval::SyncIntervalShortDescription = "Sync Interval Setting" [static]

Well known name for the sync interval policy description.

readonly string Simias::Policy::SyncInterval::IntervalTag = "Interval" [static]

Tag used to lookup and store the interval value on the policy.

readonly int Simias::Policy::SyncInterval::InfiniteSyncInterval = -1 [static]

Implies to never synchronize.

Property Documentation

int Simias::Policy::SyncInterval::Interval [get]

Gets the sync interval in seconds. If the policy is aggregated, the largest sync interval will be returned.

The documentation for this class was generated from the following file:
Generated on Wed Apr 8 14:50:03 2009 for simias by  doxygen 1.5.6