Caplin.DataSource.Messaging.Permission.IPermissionMessage Interface Reference

Interface that represents an update for a Permission message. More...

Inheritance diagram for Caplin.DataSource.Messaging.Permission.IPermissionMessage:

Public Member Functions
bool	ContainsField (string fieldName)
	Determines whether the permission message contains the specified field. More...
void	RemoveField (string fieldName)
	Removes all instances of the given field from this permission message. More...

Properties
bool	DeletePermissionKey [get, set]
	Gets or sets a value indicating whether this permission key should be deleted. More...
IList< IField >	Fields [get]
	Gets the fields within this message. More...
bool	Global [get, set]
	Gets or sets a value indicating whether this IPermissionMessage is a global permission message. More...
string	PermissionKey [get, set]
	Gets or sets the permission key. More...
string	this[string fieldName] [get, set]
	Gets or sets a specified field within this permission message. More...
Properties inherited from Caplin.DataSource.Messaging.IMessage
bool	Image [get, set]
	Gets or sets a boolean value indicating whether this IMessage represents an image or an update. More...
string	Subject [get]
	Gets the subject of this message. More...

Detailed Description

Interface that represents an update for a Permission message.

Member Function Documentation

bool Caplin.DataSource.Messaging.Permission.IPermissionMessage.ContainsField

(

string

fieldName

)

Determines whether the permission message contains the specified field.

Parameters

fieldName

Name of the field.

Returns

true if the message contains the field; otherwise, false.

void Caplin.DataSource.Messaging.Permission.IPermissionMessage.RemoveField

(

string

fieldName

)

Removes all instances of the given field from this permission message.

Parameters

fieldName

Name of the field.

Property Documentation

bool Caplin.DataSource.Messaging.Permission.IPermissionMessage.DeletePermissionKey

getset

Gets or sets a value indicating whether this permission key should be deleted.

true if the entry should be deleted; otherwise, false.

IList<IField> Caplin.DataSource.Messaging.Permission.IPermissionMessage.Fields

get

Gets the fields within this message.

A read-only list of the fields within this permission message.

bool Caplin.DataSource.Messaging.Permission.IPermissionMessage.Global

getset

Gets or sets a value indicating whether this IPermissionMessage is a global permission message.

true if global; otherwise, false.

A global permission message will be sent to the Liberator's authentication module.

string Caplin.DataSource.Messaging.Permission.IPermissionMessage.PermissionKey

getset

Gets or sets the permission key.

The permission key.

string Caplin.DataSource.Messaging.Permission.IPermissionMessage.this[string fieldName]

getset

Gets or sets a specified field within this permission message.

Field value

If the field does not exist in the permission message, this index operator adds it, otherwise using the index operator will update the value of the field.

Exceptions

Caplin.DataSource.Fields.UnknownFieldException

Raised when the fieldName is not defined in the DataSource.NET configuration.