Simias::Policy::DiskSpaceQuota Class Reference

Implements the disk space limit policy. More...

Collaboration diagram for Simias::Policy::DiskSpaceQuota:

Collaboration graph
[legend]

List of all members.

Public Member Functions

bool Allowed (long space)
 Returns whether there is sufficient disk space quota for the requested space.

Static Public Member Functions

static void Create (string domainID, long limit)
 Creates a system wide disk space quota policy.
static void Create (Member member, long limit)
 Creates a disk space quota policy for the specified member.
static void Create (Collection collection, long limit)
 Creates a disk space quota policy for the specified collection.
static void Delete (string domainID)
 Deletes a system wide disk space quota policy.
static void Delete (Member member)
 Deletes a disk space quota policy for the specified member.
static void Delete (Collection collection)
 Deletes a disk space quota policy for the specified collection.
static DiskSpaceQuota Get (Member member)
 Gets the aggregate disk space quota policy for the specified member.
static DiskSpaceQuota Get (Member member, Collection collection)
 Gets the aggregate disk space quota policy for the specified member and collection.
static DiskSpaceQuota Get (Collection collection)
 Gets the aggregate disk space quota policy for the specified collection. This includes the collection owner's quota, if one exists, or the system-wide quota and any quota set specifically on the collection.
static long GetLimit (string domainID)
 Gets the disk space quota limit associated with the specified domain.
static long GetLimit (Member member)
 Gets the disk space quota limit associated with the specified member.
static long GetLimit (Collection collection)
 Gets the disk space quota limit associated with the specified collection.
static void Set (string domainID, long limit)
 Sets the disk space quota limit associated with the specified domain.
static void Set (Member member, long limit)
 Sets the disk space quota limit associated with the specified member.
static void Set (Collection collection, long limit)
 Sets the disk space quota limit associated with the specified collection.

Static Public Attributes

static string DiskSpaceQuotaPolicyID = "d023b45d-9559-49cd-9b9f-3e41e7fdcf0d"
 Well known name for the disk space quota policy.
static string DiskSpaceQuotaShortDescription = "Disk space quota"
 Well known name for the disk space quota description.
static string UsedDiskSpaceOnServer = "Used Disk Space On Server"
 new field added so that client will have this info

Properties

long AvailableSpace [get]
 Returns the available disk space for the associated member.
long Limit [get]
 Gets the disk space quota limit.
long UsedSpace [get]
 Gets the amount of disk space in use for the associated member.

Detailed Description

Implements the disk space limit policy.

Member Function Documentation

static void Simias::Policy::DiskSpaceQuota::Create ( string  domainID,
long  limit 
) [inline, static]

Creates a system wide disk space quota policy.

Parameters:
domainID Domain that the limit will be associated with.
limit Amount of disk space that all users in the domain will be limited to.

static void Simias::Policy::DiskSpaceQuota::Create ( Member  member,
long  limit 
) [inline, static]

Creates a disk space quota policy for the specified member.

Parameters:
member Member that the limit will be associated with.
limit Amount of disk space that this member will be limited to.

static void Simias::Policy::DiskSpaceQuota::Create ( Collection  collection,
long  limit 
) [inline, static]

Creates a disk space quota policy for the specified collection.

Parameters:
collection Collection that the limit will be associated with.
limit Amount of disk space that this collection will be limited to.

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

Deletes a system wide disk space quota policy.

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

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

Deletes a disk space quota policy for the specified member.

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

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

Deletes a disk space quota policy for the specified collection.

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

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

Gets the aggregate disk space quota policy for the specified member.

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

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

Gets the aggregate disk space quota policy for the specified member and collection.

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

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

Gets the aggregate disk space quota policy for the specified collection. This includes the collection owner's quota, if one exists, or the system-wide quota and any quota set specifically on the collection.

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

static long Simias::Policy::DiskSpaceQuota::GetLimit ( string  domainID  )  [inline, static]

Gets the disk space quota limit associated with the specified domain.

Parameters:
domainID Domain that the limit is associated with.
Returns:
Amount of disk space that all users in the domain are limited to.

static long Simias::Policy::DiskSpaceQuota::GetLimit ( Member  member  )  [inline, static]

Gets the disk space quota limit associated with the specified member.

Parameters:
member Member that the limit is associated with.
Returns:
Amount of disk space that the member is limited to.

static long Simias::Policy::DiskSpaceQuota::GetLimit ( Collection  collection  )  [inline, static]

Gets the disk space quota limit associated with the specified collection.

Parameters:
collection Collection that the limit is associated with.
Returns:
Amount of disk space that the collection is limited to.

static void Simias::Policy::DiskSpaceQuota::Set ( string  domainID,
long  limit 
) [inline, static]

Sets the disk space quota limit associated with the specified domain.

Parameters:
domainID Domain that the limit is associated with.
limit Amount of disk space that all users in the domain will be limited to.

static void Simias::Policy::DiskSpaceQuota::Set ( Member  member,
long  limit 
) [inline, static]

Sets the disk space quota limit associated with the specified member.

Parameters:
member Member that the limit is associated with.
limit Amount of disk space that all users in the domain will be limited to.

static void Simias::Policy::DiskSpaceQuota::Set ( Collection  collection,
long  limit 
) [inline, static]

Sets the disk space quota limit associated with the specified collection.

Parameters:
collection Collection that the limit is associated with.
limit Amount of disk space that all users in the domain will be limited to.

bool Simias::Policy::DiskSpaceQuota::Allowed ( long  space  )  [inline]

Returns whether there is sufficient disk space quota for the requested space.

Parameters:
space Amount of space requested.
Returns:
True if the requested space is under the quota limit. Otherwise false is returned.

Member Data Documentation

string Simias::Policy::DiskSpaceQuota::DiskSpaceQuotaPolicyID = "d023b45d-9559-49cd-9b9f-3e41e7fdcf0d" [static]

Well known name for the disk space quota policy.

string Simias::Policy::DiskSpaceQuota::DiskSpaceQuotaShortDescription = "Disk space quota" [static]

Well known name for the disk space quota description.

string Simias::Policy::DiskSpaceQuota::UsedDiskSpaceOnServer = "Used Disk Space On Server" [static]

new field added so that client will have this info

Property Documentation

long Simias::Policy::DiskSpaceQuota::AvailableSpace [get]

Returns the available disk space for the associated member.

long Simias::Policy::DiskSpaceQuota::Limit [get]

Gets the disk space quota limit.

long Simias::Policy::DiskSpaceQuota::UsedSpace [get]

Gets the amount of disk space in use for the associated member.

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