Apac.Data.IAuthStore Interface Reference

The contract required by all concrete user stores. More...

Inheritance diagram for Apac.Data.IAuthStore:

Public Member Functions
List< User >	GetUsers (PredicateSet filter)
	Gets the users that match filter . More...
WhyBool	CreateUser (User user)
	Validates the inputs and creates the user. This routine assumes the password has already been hashed and salted and applied to the user object. More...
WhyBool	DeleteUser (int id)
	Deletes the user with id . More...
WhyBool	UpdateUser (User user)
	Updates the user and associations to look like user . More...
List< NotificationGroup >	GetNotificationGroups ()
	Gets all notification groups. More...
WhyBool	CreateNotificationGroup (string name, ref NotificationGroup group)
	Creates a notification group with name . More...
WhyBool	UpdateNotificationGroup (NotificationGroup ng)
	Updates the notificaton group. More...
WhyBool	DeleteNotificationGroup (short id)
	Deletes the notification group with id . More...

Properties
List< string >	Roles [get]
	Gets the currently configured roles, possibly from cache. More...
List< NotificationGroup >	NotificationGroups [get]
	Gets the currently configured notification groups, possibly from cache. More...

Detailed Description

The contract required by all concrete user stores.

Member Function Documentation

CreateNotificationGroup()

WhyBool Apac.Data.IAuthStore.CreateNotificationGroup	(	string	name,
		ref NotificationGroup	group
	)

Creates a notification group with name .

Parameters

name	The name.
group	The group.

Returns

Returns a WhyBool containing status of the operation and a reference to the new NotificationGroup.

CreateUser()

WhyBool Apac.Data.IAuthStore.CreateUser

(

User

user

)

Validates the inputs and creates the user. This routine assumes the password has already been hashed and salted and applied to the user object.

Parameters

user

The user.

Returns

Returns a WhyBool containing status of the operation and updates the user object to be complete after creation.

DeleteNotificationGroup()

WhyBool Apac.Data.IAuthStore.DeleteNotificationGroup

(

short

id

)

Deletes the notification group with id .

Parameters

id	The identifier.

Returns

Returns a WhyBool containing status of the operation.

Implemented in Apac.Data.DatabaseStore.

DeleteUser()

WhyBool Apac.Data.IAuthStore.DeleteUser

(

int

id

)

Deletes the user with id .

Parameters

id	The identifier.

Returns

Returns a WhyBool containing status of the operation.

Implemented in Apac.Data.DatabaseStore.

GetNotificationGroups()

List<NotificationGroup> Apac.Data.IAuthStore.GetNotificationGroups

(

)

Gets all notification groups.

Returns

Returns a T:List<NotificationGroup> containing the NotificationGroup.

Implemented in Apac.Data.DatabaseStore.

GetUsers()

List<User> Apac.Data.IAuthStore.GetUsers

(

PredicateSet

filter

)

Gets the users that match filter .

Parameters

filter

The filter.

Returns

Returns a T:List<User> containing the users.

UpdateNotificationGroup()

WhyBool Apac.Data.IAuthStore.UpdateNotificationGroup

(

NotificationGroup

ng

)

Updates the notificaton group.

Parameters

ng

The ng.

Returns

Returns a WhyBool containing status of the operation.

Implemented in Apac.Data.DatabaseStore.

UpdateUser()

WhyBool Apac.Data.IAuthStore.UpdateUser

(

User

user

)

Updates the user and associations to look like user .

Parameters

user

The user.

Returns

Returns a WhyBool containing status of the operation.

Property Documentation

NotificationGroups

List<NotificationGroup> Apac.Data.IAuthStore.NotificationGroups

get

Gets the currently configured notification groups, possibly from cache.

The notification groups.

Roles

List<string> Apac.Data.IAuthStore.Roles

get

Gets the currently configured roles, possibly from cache.

The roles.

---

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

• /var/lib/jenkins/workspace/apac/APAC/APACCore/Data/IAuthStore.cs