Simias::Policy::Policy Class Reference

Policy object definition. More...

Inheritance diagram for Simias::Policy::Policy:

[legend]

Collaboration diagram for Simias::Policy::Policy:

[legend]

List of all members.

Public Member Functions
	Policy (string policyID, string shortDescription)
	Constructor for creating a new Policy object.
	Policy (Node node)
	Constructor that creates a Policy object from a Node object.
	Policy (Collection collection, ShallowNode shallowNode)
	Constructor that creates a Policy object from a ShallowNode object.
void	AddRule (Rule rule)
	Adds a rule to the policy.
void	AddTimeCondition (PolicyTime time)
	Adds a time condition to the rule to indicate when the policy is effective.
void	AddValue (string name, object value)
	Adds a named value to the policy.
Rule.Result	Apply (object input, string PolicyID)
	Applies the policy rules on the specified object to determine if the result is allowed or denied.
void	DeleteRule (Rule rule)
	Removes the specified rule from the policy.
void	DeleteTimeCondition ()
	Removes the time condition for the policy.
void	DeleteValue (string name)
	Removes the specified value from the policy.
object	GetValue (string name)
	Gets the policy value from its name.
Properties
string	Description [get, set]
	Gets or sets the detailed description for this system policy.
bool	IsSystemPolicy [get, set]
	Gets or sets whether this is a system policy.
PolicyTime	PolicyTime [get]
	Returns the PolicyTime object for this policy. If there is no time condition, null is returned.
ICSList	Rules [get]
	Returns the list of Rule objects for this policy. If this is an aggregated Policy, all rules from the aggregated Policies are returned.
string	StrongName [get]
	Gets the strong name for this system policy.
string	Title [get, set]
	Gets or sets the title for the system policy.
PolicyValue[]	Values [get]
	Returns a collection of policy values. If this is an aggregated policy, all values from the aggregated policies are returned.

---

Detailed Description

Policy object definition.

---

Constructor & Destructor Documentation

Simias::Policy::Policy::Policy	(	string	policyID,
		string	shortDescription
	)			[inline]

Constructor for creating a new Policy object.

Parameters:

	policyID	Strong name of the policy. This should be a well-known GUID.
	shortDescription	A short friendly description of the policy.

Simias::Policy::Policy::Policy

(

Node

node

)

[inline]

Constructor that creates a Policy object from a Node object.

Parameters:

node

Node object to create the Policy object from.

Simias::Policy::Policy::Policy	(	Collection	collection,
		ShallowNode	shallowNode
	)			[inline]

Constructor that creates a Policy object from a ShallowNode object.

Parameters:

	collection	Collection that the specified Node object belongs to.
	shallowNode	ShallowNode object to create the Policy object from.

---

Member Function Documentation

void Simias::Policy::Policy::AddRule

(

Rule

rule

)

[inline]

Adds a rule to the policy.

Parameters:

rule

Object that is used to match against the input in the policy.

void Simias::Policy::Policy::AddTimeCondition

(

PolicyTime

time

)

[inline]

Adds a time condition to the rule to indicate when the policy is effective.

Parameters:

time

PolicyTime object that determines when the policy is effective.

void Simias::Policy::Policy::AddValue	(	string	name,
		object	value
	)			[inline]

Adds a named value to the policy.

Parameters:

	name	Name of the value.
	value	Value to set on the policy.

Rule.Result Simias::Policy::Policy::Apply	(	object	input,
		string	PolicyID
	)			[inline]

Applies the policy rules on the specified object to determine if the result is allowed or denied.

Parameters:

	input	Object that is used to match against the policy rules. The type of object must be one of the Simias.Syntax types.
	PolicyID	If member Policy object has called it,then pass the specific policyid , for other policy objects , pass null

Returns:

True if the policy allows the operation, otherwise false is returned.

void Simias::Policy::Policy::DeleteRule

(

Rule

rule

)

[inline]

Removes the specified rule from the policy.

Parameters:

rule

Rule that is used to match against the input in the policy.

void Simias::Policy::Policy::DeleteTimeCondition

(

)

[inline]

Removes the time condition for the policy.

void Simias::Policy::Policy::DeleteValue

(

string

name

)

[inline]

Removes the specified value from the policy.

Parameters:

name

Name of the value to delete.

object Simias::Policy::Policy::GetValue

(

string

name

)

[inline]

Gets the policy value from its name.

Parameters:

name

Name of the policy value.

Returns:

An object containing the policy value. If the policy value does not exist a null is returned.

---

Property Documentation

string Simias::Policy::Policy::Description [get, set]

Gets or sets the detailed description for this system policy.

bool Simias::Policy::Policy::IsSystemPolicy [get, set]

Gets or sets whether this is a system policy.

PolicyTime Simias::Policy::Policy::PolicyTime [get]

Returns the PolicyTime object for this policy. If there is no time condition, null is returned.

ICSList Simias::Policy::Policy::Rules [get]

Returns the list of Rule objects for this policy. If this is an aggregated Policy, all rules from the aggregated Policies are returned.

string Simias::Policy::Policy::StrongName [get]

Gets the strong name for this system policy.

string Simias::Policy::Policy::Title [get, set]

Gets or sets the title for the system policy.

PolicyValue [] Simias::Policy::Policy::Values [get]

Returns a collection of policy values. If this is an aggregated policy, all values from the aggregated policies are returned.

---

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

• src/core/CollectionStore/Policy.cs