Interface ISecurityListDAL

Interface to manage ISecurityListDAL data.

Namespace: Microsoft.GNS.Roster.DataAccess

Assembly: Microsoft.GNS.Roster.DataAccess.dll

Syntax

public interface ISecurityListDAL

Methods

DeletePermissionsListsForParentAsync(Guid, Scope)

Deletes permission entity lists for a given parent.

Declaration

Task DeletePermissionsListsForParentAsync(Guid parentId, Scope scope)

Parameters

Type	Name	Description
Guid	parentId	The parent object Id in which to delete permissions entity lists.
Scope	scope	The scope of the security list parent.

Returns

Type	Description
Task	A task representing the work to delete a permissions entity list.

DeletePrincipalListsForParentAsync(Guid, Scope)

Deletes principal entity lists for a given parent.

Declaration

Task DeletePrincipalListsForParentAsync(Guid parentId, Scope scope)

Parameters

Type	Name	Description
Guid	parentId	The parent object Id in which to delete principal lists.
Scope	scope	The scope of the principal list parent.

Returns

Type	Description
Task	A task representing the work to delete a principal list.

GetPermissionsListAsync(Guid, String, Scope)

Gets a reference list for permission entities.

Declaration

Task<IPermissionEntityRefList> GetPermissionsListAsync(Guid parentId, string name, Scope scope)

Parameters

Type	Name	Description
Guid	parentId	The Id of the parent this list belongs to.
System.String	name	The property name of the list in the parent object.
Scope	scope	The Roster scope.

Returns

Type	Description
Task<IPermissionEntityRefList>	An object that represents a permission entity list.

GetPrincipalListAsync(Guid, String, Scope)

Gets a principal list.

Declaration

Task<IRosterPrincipalRefList> GetPrincipalListAsync(Guid parentId, string name, Scope scope)

Parameters

Type	Name	Description
Guid	parentId	The Id of the parent this list belongs to.
System.String	name	The property name of the list in the parent object.
Scope	scope	The Roster scope.

Returns

Type	Description
Task<IRosterPrincipalRefList>	An object that represents a principal list.

SavePermissionsListAsync(IPermissionEntityRefList)

Saves a permission entity list.

Declaration

Task<IPermissionEntityRefList> SavePermissionsListAsync(IPermissionEntityRefList list)

Parameters

Type	Name	Description
IPermissionEntityRefList	list	The list to save.

Returns

Type	Description
Task<IPermissionEntityRefList>	The saved list.

SavePrincipalListAsync(IRosterPrincipalRefList)

Saves a principal list.

Declaration

Task<IRosterPrincipalRefList> SavePrincipalListAsync(IRosterPrincipalRefList list)

Parameters

Type	Name	Description
IRosterPrincipalRefList	list	The list to save.

Returns

Type	Description
Task<IRosterPrincipalRefList>	The saved list.