Simias::Storage::Domain Class Reference

Class that represents a Domain object in the Collection Store. More...

Inheritance diagram for Simias::Storage::Domain:

[legend]

Collaboration diagram for Simias::Storage::Domain:

[legend]

List of all members.

Public Types
enum	ConfigurationType { None, Workgroup, ClientServer }
	Defines the different types of synchronization configurations. More...
Public Member Functions
	Domain (Store store, string domainName, string domainID, string description, SyncRoles role, ConfigurationType configType)
	Domain (Store storeObject, Node node)
	Constructor to create an existing Domain object from a Node object.
	Domain (Store storeObject, ShallowNode shallowNode)
	Constructor for creating an existing Domain object from a ShallowNode.
bool	IsLoginDisabledForUser (Member member)
	Returns if the specified user's login is disabled.
bool	IsLoginDisabled (string userID)
	Returns if the specified user's login is disabled.
bool	GetLoginpolicy (string userID)
	Returns if the specified user's login is disabled.
void	SetLoginDisabled (string userID, bool disable)
	Sets the specified user's login disabled status.
override string	ToString ()
	Obtains the string representation of this instance.
Static Public Attributes
static string	SectionName = "Domain"
	Configuration section name where enterprise key value pairs are stored.
static readonly Version	CurrentDomainVersion = new Version( "1.0.0.0" )
	Current version of the domain.
Properties
ConfigurationType	ConfigType [get]
	Gets the domain configuration type.
string	Description [get, set]
	Gets or sets the domain description.
ulong	SystemSyncStatus [get, set]
	Catalog , Domain Sync status.
Version	ServerVersion [get, set]
	Gets or sets the version of this domain.
bool	SupportsNewInvitation [get]
	Used to determine if the domain supports the new invitation model.
Version	DomainVersion [get, set]
	Gets or sets the version of this domain.

---

Detailed Description

Class that represents a Domain object in the Collection Store.

---

Member Enumeration Documentation

enum Simias::Storage::Domain::ConfigurationType

Defines the different types of synchronization configurations.

---

Constructor & Destructor Documentation

Simias::Storage::Domain::Domain	(	Store	store,
		string	domainName,
		string	domainID,
		string	description,
		SyncRoles	role,
		ConfigurationType	configType
	)			[inline]

Parameters:

	store	Store object.
	domainName	Name of the domain.
	domainID	Well known unique identifier for the domain.
	description	String that describes this domain.
	role	The type of synchronization role this domain has.
	configType	The synchronization configuration type for this domain.

Simias::Storage::Domain::Domain	(	Store	storeObject,
		Node	node
	)			[inline]

Constructor to create an existing Domain object from a Node object.

Parameters:

	storeObject	Store object that this collection belongs to.
	node	Node object to construct this object from.

Simias::Storage::Domain::Domain	(	Store	storeObject,
		ShallowNode	shallowNode
	)			[inline]

Constructor for creating an existing Domain object from a ShallowNode.

Parameters:

	storeObject	Store object that this collection belongs to.
	shallowNode	A ShallowNode object.

---

Member Function Documentation

bool Simias::Storage::Domain::IsLoginDisabledForUser

(

Member

member

)

[inline]

Returns if the specified user's login is disabled.

Parameters:

userID

User ID for the member to check.

Returns:

True if the login for the specified user is disabled.

bool Simias::Storage::Domain::IsLoginDisabled

(

string

userID

)

[inline]

Returns if the specified user's login is disabled.

Parameters:

userID

User ID for the member to check.

Returns:

True if the login for the specified user is disabled.

bool Simias::Storage::Domain::GetLoginpolicy

(

string

userID

)

[inline]

Returns if the specified user's login is disabled.

Parameters:

userID

User ID for the member to check.

Returns:

True if the login for the specified user is disabled.

void Simias::Storage::Domain::SetLoginDisabled	(	string	userID,
		bool	disable
	)			[inline]

Sets the specified user's login disabled status.

Parameters:

	userID	User ID for the member to set the status for.
	disable	True to disable login or False to enable login.

override string Simias::Storage::Domain::ToString

(

)

[inline]

Obtains the string representation of this instance.

Returns:

The friendly name of the domain.

---

Member Data Documentation

string Simias::Storage::Domain::SectionName = "Domain" [static]

Configuration section name where enterprise key value pairs are stored.

readonly Version Simias::Storage::Domain::CurrentDomainVersion = new Version( "1.0.0.0" ) [static]

Current version of the domain.

---

Property Documentation

ConfigurationType Simias::Storage::Domain::ConfigType [get]

Gets the domain configuration type.

string Simias::Storage::Domain::Description [get, set]

Gets or sets the domain description.

ulong Simias::Storage::Domain::SystemSyncStatus [get, set]

Catalog , Domain Sync status.

Version Simias::Storage::Domain::ServerVersion [get, set]

Gets or sets the version of this domain.

bool Simias::Storage::Domain::SupportsNewInvitation [get]

Used to determine if the domain supports the new invitation model.

Version Simias::Storage::Domain::DomainVersion [get, set]

Gets or sets the version of this domain.

---

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

• src/core/CollectionStore/Domain.cs