Simias::Policy::FileTypeFilter Class Reference

Implements the file type filter policy. More...

Collaboration diagram for Simias::Policy::FileTypeFilter:

Collaboration graph
[legend]

List of all members.

Public Member Functions

bool Allowed (string fileName)
 Returns whether the specified file is allowed to pass through the filter.

Static Public Member Functions

static void Create (string domainID, FileTypeEntry[] patterns)
 Creates a system wide file filter policy.
static void Create (Member member, FileTypeEntry[] patterns)
 Creates a file type filter policy for the specified member.
static void Create (Collection collection, FileTypeEntry[] patterns)
 Creates a file type filter policy for the specified collection.
static void Create (FileTypeEntry[] patterns)
 Creates a file type filter policy for the current user on the current machine.
static void Delete (string domainID)
 Deletes a system wide file filter policy.
static void Delete (Member member)
 Deletes a file type filter policy for the specified member.
static void Delete (Collection collection)
 Deletes a file type filter policy for the specified collection.
static void Delete ()
 Deletes a file type filter policy for the current user on the current machine.
static FileTypeFilter Get (Member member)
 Gets the aggregate file type filter policy for the specified member.
static FileTypeFilter Get (Member member, Collection collection)
 Gets the aggregate file type filter policy for the specified member and collection.
static FileTypeFilter Get (Collection collection)
 Gets the aggregate file type filter policy for the specified member and collection.
static FileTypeEntry[] GetPatterns (string domainID)
 Gets the file type filter patterns associated with the specified domain.
static FileTypeEntry[] GetPatterns (Member member)
 Gets the file type filter patterns associated with the specified member.
static FileTypeEntry[] GetPatterns (Collection collection)
 Gets the file type filter patterns associated with the specified collection.
static FileTypeEntry[] GetPatterns ()
 Gets the file type filter patterns associated with the current user on the current machine.
static void Set (string domainID, FileTypeEntry[] patterns)
 Sets the file type filter associated with the specified domain.
static void Set (Member member, FileTypeEntry[] patterns)
 Sets the file type filter associated with the specified member.
static void Set (Collection collection, FileTypeEntry[] patterns)
 Sets the file type filter associated with the specified collection.
static void Set (FileTypeEntry[] patterns)
 Sets the file type filter associated with the current user on the current machine.

Static Public Attributes

static string FileTypeFilterPolicyID = "e69ff680-3f75-412e-a929-1b0247ed4041"
 Well known name for the file type filter policy.
static string FileTypeFilterShortDescription = "File type filter"
 Well known name for the file type filter policy description.

Properties

FileTypeEntry[] FilterList [get]
 Gets the file type filter list.
FileTypeEntry[] FilterUserList [get]
 Gets the file type filter list.


Detailed Description

Implements the file type filter policy.


Member Function Documentation

static void Simias::Policy::FileTypeFilter::Create ( string  domainID,
FileTypeEntry[]  patterns 
) [inline, static]

Creates a system wide file filter policy.

Parameters:
domainID Domain that the filter will be associated with.
patterns File type patterns that will be used to filter files.

static void Simias::Policy::FileTypeFilter::Create ( Member  member,
FileTypeEntry[]  patterns 
) [inline, static]

Creates a file type filter policy for the specified member.

Parameters:
member Member that the filter will be associated with.
patterns File type patterns that will be used to filter files.

static void Simias::Policy::FileTypeFilter::Create ( Collection  collection,
FileTypeEntry[]  patterns 
) [inline, static]

Creates a file type filter policy for the specified collection.

Parameters:
collection Collection that the filter will be associated with.
patterns File type patterns that will be used to filter files.

static void Simias::Policy::FileTypeFilter::Create ( FileTypeEntry[]  patterns  )  [inline, static]

Creates a file type filter policy for the current user on the current machine.

Parameters:
patterns File type patterns that will be used to filter files.

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

Deletes a system wide file filter policy.

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

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

Deletes a file type filter policy for the specified member.

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

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

Deletes a file type filter policy for the specified collection.

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

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

Deletes a file type filter policy for the current user on the current machine.

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

Gets the aggregate file type filter policy for the specified member.

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

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

Gets the aggregate file type filter policy for the specified member and collection.

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

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

Gets the aggregate file type filter policy for the specified member and collection.

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

static FileTypeEntry [] Simias::Policy::FileTypeFilter::GetPatterns ( string  domainID  )  [inline, static]

Gets the file type filter patterns associated with the specified domain.

Parameters:
domainID Domain that the filter is associated with.
Returns:
Array of file type filter patterns for this policy if successful. If there are no filter patterns then null is returned.

static FileTypeEntry [] Simias::Policy::FileTypeFilter::GetPatterns ( Member  member  )  [inline, static]

Gets the file type filter patterns associated with the specified member.

Parameters:
member Member that the filter is associated with.
Returns:
Array of file type filter patterns for this policy if successful. If there are no filter patterns then null is returned.

static FileTypeEntry [] Simias::Policy::FileTypeFilter::GetPatterns ( Collection  collection  )  [inline, static]

Gets the file type filter patterns associated with the specified collection.

Parameters:
collection Collection that the limit is associated with.
Returns:
Array of file type filter patterns for this policy if successful. If there are no filter patterns then null is returned.

static FileTypeEntry [] Simias::Policy::FileTypeFilter::GetPatterns (  )  [inline, static]

Gets the file type filter patterns associated with the current user on the current machine.

Returns:
Array of file type filter patterns for this policy if successful. If there are no filter patterns then null is returned.

static void Simias::Policy::FileTypeFilter::Set ( string  domainID,
FileTypeEntry[]  patterns 
) [inline, static]

Sets the file type filter associated with the specified domain.

Parameters:
domainID Domain that the filter is associated with.
patterns File type patterns that will be used to filter files.

static void Simias::Policy::FileTypeFilter::Set ( Member  member,
FileTypeEntry[]  patterns 
) [inline, static]

Sets the file type filter associated with the specified member.

Parameters:
member Member that the filter is associated with.
patterns File type patterns that will be used to filter files.

static void Simias::Policy::FileTypeFilter::Set ( Collection  collection,
FileTypeEntry[]  patterns 
) [inline, static]

Sets the file type filter associated with the specified collection.

Parameters:
collection Collection that the filter is associated with.
patterns File type patterns that will be used to filter files.

static void Simias::Policy::FileTypeFilter::Set ( FileTypeEntry[]  patterns  )  [inline, static]

Sets the file type filter associated with the current user on the current machine.

Parameters:
patterns File type patterns that will be used to filter files.

bool Simias::Policy::FileTypeFilter::Allowed ( string  fileName  )  [inline]

Returns whether the specified file is allowed to pass through the filter.

Parameters:
fileName Name of the file including its extension.
Returns:
True if the file is allowed to pass through the filter. Otherwise false is returned.


Member Data Documentation

string Simias::Policy::FileTypeFilter::FileTypeFilterPolicyID = "e69ff680-3f75-412e-a929-1b0247ed4041" [static]

Well known name for the file type filter policy.

Well known name for the file type filter policy description.


Property Documentation

FileTypeEntry [] Simias::Policy::FileTypeFilter::FilterList [get]

Gets the file type filter list.

FileTypeEntry [] Simias::Policy::FileTypeFilter::FilterUserList [get]

Gets the file type filter list.


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

Generated on Wed Apr 8 14:49:54 2009 for simias by  doxygen 1.5.6