Interface IWorkspacePermissionService

Represents the workspace permission API service.

Namespace: Relativity.Testing.Framework.Api.Services
Assembly: Relativity.Testing.Framework.Api.dll
Syntax
public interface IWorkspacePermissionService
Examples
IWorkspacePermissionService _workspacePermissionService = relativityFacade.Resolve<IWorkspacePermissionService>();

Methods

| Improve this Doc View Source

AddRemoveWorkspaceGroups(Int32, GroupSelector)

Add and remove groups to and from admin permissions.

Declaration
void AddRemoveWorkspaceGroups(int workspaceId, GroupSelector groupSelector)
Parameters
Type Name Description
System.Int32 workspaceId

The case artifact ID of workspace.
GroupSelector groupSelector

The selector of enabled/disabled groups for an entity.
Examples
int workspaceID = 123456;

GroupSelector selector =  _workspacePermissionService.GetWorkspaceGroupSelector(workspaceID);

var disabledGroup = selector.DisabledGroups.Last();
selector.DisabledGroups.RemoveAll(x => x.ArtifactID == disabledGroup.ArtifactID);
selector.EnabledGroups.Add(disabledGroup);

_workspacePermissionService.AddRemoveWorkspaceGroups(workspaceID, selector);
| Improve this Doc View Source

AddWorkspaceToGroup(Int32, Int32)

Adds the workspace to the group.

Declaration
void AddWorkspaceToGroup(int workspaceId, int groupId)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
System.Int32 groupId

The group ID.
Examples
int workspaceID = 123456;
int groupID = 654321;

_workspacePermissionService.AddWorkspaceToGroup(workspaceID, groupID);
| Improve this Doc View Source

AddWorkspaceToGroup(Int32, String)

Adds the workspace to the group.

Declaration
void AddWorkspaceToGroup(int workspaceId, string groupName)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
System.String groupName

The group Name.
Examples
int workspaceID = 123456;
string groupName = "Group Name";

_workspacePermissionService.AddWorkspaceToGroup(workspaceID, groupName);
| Improve this Doc View Source

AddWorkspaceToGroups(Int32, Int32[])

Adds the workspace to the groups.

Declaration
void AddWorkspaceToGroups(int workspaceId, params int[] groupIds)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
System.Int32[] groupIds

The group IDs.
Examples
int workspaceID = 123456;
int[] groups = new[] {987654, 654321};

_workspacePermissionService.AddWorkspaceToGroups(workspaceID, groups);
| Improve this Doc View Source

AddWorkspaceToGroups(Int32, String[])

Adds the workspace to the groups.

Declaration
void AddWorkspaceToGroups(int workspaceId, params string[] groupNames)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
System.String[] groupNames

The group Names.
Examples
int workspaceID = 123456;
string[] groups = new[] {"First Group", "Second Group"};

_workspacePermissionService.AddWorkspaceToGroups(workspaceID, groups);
| Improve this Doc View Source

GetWorkspaceGroupPermissions(Int32, Int32)

Gets the the group permissions for the workspace.

Declaration
GroupPermissions GetWorkspaceGroupPermissions(int workspaceId, int groupId)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
System.Int32 groupId

The group ID.
Returns
Type Description
GroupPermissions

An instance of GroupPermissions or null if the workspace is not added to the group.
Examples
int workspaceID = 123456;
int groupID = 654321;

GroupPermissions permissions = _workspacePermissionService.GetWorkspaceGroupPermissions(workspaceID, groupID);
| Improve this Doc View Source

GetWorkspaceGroupPermissions(Int32, String)

Gets the the group permissions for the workspace.

Declaration
GroupPermissions GetWorkspaceGroupPermissions(int workspaceId, string groupName)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
System.String groupName

The group Name.
Returns
Type Description
GroupPermissions

An instance of GroupPermissions or null if the workspace is not added to the group.
Examples
int workspaceID = 123456;
string groupName = "Group Name";

GroupPermissions permissions = _workspacePermissionService.GetWorkspaceGroupPermissions(workspaceID, groupName);
| Improve this Doc View Source

GetWorkspaceGroupSelector(Int32)

Gets the group selector of specified workspace.

Declaration
GroupSelector GetWorkspaceGroupSelector(int workspaceId)
Parameters
Type Name Description
System.Int32 workspaceId

The case artifact ID of workspace.
Returns
Type Description
GroupSelector

The group selector entity.
Examples
int workspaceID = 123456;

GroupSelector groupSelector =  _workspacePermissionService.GetWorkspaceGroupSelector(workspaceID);
| Improve this Doc View Source

SetWorkspaceGroupPermissions(Int32, GroupPermissions)

Sets the group permissions for the workspace.

Declaration
void SetWorkspaceGroupPermissions(int workspaceId, GroupPermissions groupPermissions)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
GroupPermissions groupPermissions

The group permissions.
Examples
int workspaceID = 123456;
string groupName = "Group Name";

GroupPermissions permissions = _workspacePermissionService.GetWorkspaceGroupPermissions(workspaceID, groupName);
permissions.ObjectPermissions[0].ViewSelected = true;

_workspacePermissionService.SetWorkspaceGroupPermissions(workspaceID, permissions);
| Improve this Doc View Source

SetWorkspaceGroupPermissions(Int32, Int32, GroupPermissionsChangeset)

Sets the group permissions for the workspace using changeset.

Declaration
void SetWorkspaceGroupPermissions(int workspaceId, int groupId, GroupPermissionsChangeset groupPermissionsChangeset)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
System.Int32 groupId

The group ID.
GroupPermissionsChangeset groupPermissionsChangeset

The group permissions changeset.
Examples
int workspaceID = 123456;
int groupID = 654321;
string permissionName = "Object Rule";

var groupPermissionsChangeset = new GroupPermissionsChangeset();
groupPermissionsChangeset.ObjectPermissions[permissionName].Set(ObjectPermissionKinds.View);

_workspacePermissionService.SetWorkspaceGroupPermissions(workspaceID, groupID, groupPermissionsChangeset);
| Improve this Doc View Source

SetWorkspaceGroupPermissions(Int32, Int32, Action<GroupPermissionsChangeset>)

Sets the group permissions for the workspace using changeset setter.

Declaration
void SetWorkspaceGroupPermissions(int workspaceId, int groupId, Action<GroupPermissionsChangeset> groupPermissionsChangesetSetter)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
System.Int32 groupId

The group ID.
System.Action<GroupPermissionsChangeset> groupPermissionsChangesetSetter

An action to perform the changes to the group permissions.
Examples
int workspaceID = 123456;
int groupID = 654321;
string permissionName = "Object Rule";

_workspacePermissionService.SetWorkspaceGroupPermissions(workspaceID, groupID, x => x.ObjectPermissions[permissionName].Set(ObjectPermissionKinds.View);
| Improve this Doc View Source

SetWorkspaceGroupPermissions(Int32, String, GroupPermissionsChangeset)

Sets the group permissions for the workspace using changeset.

Declaration
void SetWorkspaceGroupPermissions(int workspaceId, string groupName, GroupPermissionsChangeset groupPermissionsChangeset)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
System.String groupName

The group Name.
GroupPermissionsChangeset groupPermissionsChangeset

The group permissions changeset.
Examples
int workspaceID = 123456;
string groupName = "Group Name";
string permissionName = "Object Rule";

var groupPermissionsChangeset = new GroupPermissionsChangeset();
groupPermissionsChangeset.ObjectPermissions[permissionName].Set(ObjectPermissionKinds.View);

_workspacePermissionService.SetWorkspaceGroupPermissions(workspaceID, groupName, groupPermissionsChangeset);
| Improve this Doc View Source

SetWorkspaceGroupPermissions(Int32, String, Action<GroupPermissionsChangeset>)

Sets the group permissions for the workspace using changeset setter.

Declaration
void SetWorkspaceGroupPermissions(int workspaceId, string groupName, Action<GroupPermissionsChangeset> groupPermissionsChangesetSetter)
Parameters
Type Name Description
System.Int32 workspaceId

The workspace ID.
System.String groupName

The group Name.
System.Action<GroupPermissionsChangeset> groupPermissionsChangesetSetter

An action to perform the changes to the group permissions.
Examples
int workspaceID = 123456;
string groupName = "Group Name";
string permissionName = "Object Rule";

_workspacePermissionService.SetWorkspaceGroupPermissions(workspaceID, groupName, x => x.ObjectPermissions[permissionName].Set(ObjectPermissionKinds.View));