Interface IItemPermissionService

Represents the item permission API service.

Namespace: Relativity.Testing.Framework.Api.Services

Assembly: Relativity.Testing.Framework.Api.dll

Syntax

public interface IItemPermissionService

Examples

IItemPermissionService _itemPermissionService = relativityFacade.Resolve<IItemPermissionService>();

Methods

| Improve this Doc View Source

AddItemToGroup(Int32, Int32, String)

Adds the item to the group.

Declaration

void AddItemToGroup(int workspaceId, int itemId, string groupName)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.
System.String	groupName	The group name.

Examples

int workspaceID = 123456;
int itemID = 654321;
string groupName = "Some group name";

_itemPermissionService.AddItemToGroup(workspaceID, itemID, groupName);

| Improve this Doc View Source

AddItemToGroups(Int32, Int32, String[])

Adds the item to the groups.

Declaration

void AddItemToGroups(int workspaceId, int itemId, params string[] groupNames)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.
System.String[]	groupNames	The group names.

Examples

int workspaceID = 123456;
int itemID = 654321;
string[] groupNames = new string[] { "First group name", "Second gorup name"};

_itemPermissionService.AddItemToGroups(workspaceID, itemID, groupNames);

| Improve this Doc View Source

AddRemoveItemGroups(Int32, Int32, GroupSelector, Boolean)

Add and remove groups to and from item permissions.

Declaration

void AddRemoveItemGroups(int workspaceId, int itemId, GroupSelector groupSelector, bool enableLevelSecurity = true)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The case artifact ID of workspace.
GroupSelector	groupSelector	The selector of enabled/disabled groups for an entity.
System.Boolean	enableLevelSecurity	The value which indicating whether it should enable level security. By default true.

Examples

int workspaceID = 123456;
int itemID = 654321;
string groupName = "Some group name";

GroupSelector groupSelector =  _itemPermissionService.GetItemGroupSelector(workspaceID, itemID);
var toBeEnabledGroup = selector.DisabledGroups.FirstOrDefault(x => x.Name == groupName);

if (toBeEnabledGroup != null)
{
	selector.DisabledGroups.RemoveAll(x => x.ArtifactID == toBeEnabledGroup.ArtifactID);
	selector.EnabledGroups.Add(toBeEnabledGroup);

	_itemPermissionService.AddRemoveItemGroups(workspaceID, itemID, groupSelector);
}

| Improve this Doc View Source

GetItemGroupPermissions(Int32, Int32, Int32)

Gets the the item group permissions.

Declaration

GroupPermissions GetItemGroupPermissions(int workspaceId, int itemId, int groupId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.
System.Int32	groupId	The group ID.

Returns

Type	Description
GroupPermissions	An instance of GroupPermissions or null.

Examples

int workspaceID = 123456;
int itemID = 654321;
int groupID = 765432;

GroupPermissions groupPermissions = _itemPermissionService.GetItemGroupPermissions(workspaceID, itemID, groupID);

| Improve this Doc View Source

GetItemGroupSelector(Int32, Int32)

Gets the item group selector by workspace and item ID.

Declaration

GroupSelector GetItemGroupSelector(int workspaceId, int itemId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.

Returns

Type	Description
GroupSelector	The item group selector.

Examples

int workspaceID = 123456;
int itemID = 654321;

GroupSelector groupSelector =  _itemPermissionService.GetItemGroupSelector(workspaceID, itemID);

| Improve this Doc View Source

GetItemLevelSecurity(Int32, Int32)

Gets the the group permissions for the item.

Declaration

ItemLevelSecurity GetItemLevelSecurity(int workspaceId, int itemId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.

Returns

Type	Description
ItemLevelSecurity	An instance of ItemLevelSecurity.

Examples

int workspaceID = 123456;
int itemID = 654321;

ItemLevelSecurity itemLevelSecurity = _itemPermissionService.GetItemLevelSecurity(workspaceID, itemID);

| Improve this Doc View Source

RemoveItemFromGroup(Int32, Int32, Int32)

Removes the item from the group.

Declaration

void RemoveItemFromGroup(int workspaceId, int itemId, int groupId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.
System.Int32	groupId	The group id.

Examples

int workspaceID = 123456;
int itemID = 654321;
int groupID = 765432;

_itemPermissionService.RemoveItemFromGroup(workspaceID, itemID, groupID);

| Improve this Doc View Source

RemoveItemFromGroup(Int32, Int32, String)

Removes the item from the group.

Declaration

void RemoveItemFromGroup(int workspaceId, int itemId, string groupName)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.
System.String	groupName	The group name.

Examples

int workspaceID = 123456;
int itemID = 654321;
string groupName = "Some group name";

_itemPermissionService.RemoveItemFromGroup(workspaceID, itemID, groupName);

| Improve this Doc View Source

RemoveItemFromGroups(Int32, Int32, Int32[])

Removes the item from the groups.

Declaration

void RemoveItemFromGroups(int workspaceId, int itemId, params int[] groupIds)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.
System.Int32[]	groupIds	The group ids.

Examples

int workspaceID = 123456;
int itemID = 654321;
int[] groupIds = new int[] { 123568, 785429};

_itemPermissionService.RemoveItemFromGroups(workspaceID, itemID, groupIds);

| Improve this Doc View Source

RemoveItemFromGroups(Int32, Int32, String[])

Removes the item from the groups.

Declaration

void RemoveItemFromGroups(int workspaceId, int itemId, params string[] groupNames)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.
System.String[]	groupNames	The group names.

Examples

int workspaceID = 123456;
int itemID = 654321;
string[] groupNames = new string[] { "First group name", "Second gorup name"};

_itemPermissionService.RemoveItemFromGroups(workspaceID, itemID, groupNames);

| Improve this Doc View Source

SetItemGroupPermissions(Int32, Int32, GroupPermissions)

Sets the item group permissions.

Declaration

void SetItemGroupPermissions(int workspaceId, int itemId, GroupPermissions groupPermissions)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.
GroupPermissions	groupPermissions	The group permissions.

Examples

int workspaceID = 123456;
int itemID = 654321;
int groupID = 765432;

GroupPermissions groupPermissions = _itemPermissionService.GetItemGroupPermissions(workspaceID, itemID, groupID);
if (groupPermissions != null)
{
	groupPermissions.ObjectPermissions[0].EditEditable = false;
	groupPermissions.ObjectPermissions[0].AddEditable = false;
	groupPermissions.ObjectPermissions[0].EditSelected = false;
}

_itemPermissionService.SetItemGroupPermissions(workspaceID, itemID, groupPermissions);

| Improve this Doc View Source

SetItemGroupPermissions(Int32, Int32, Int32, GroupPermissionsChangeset)

Sets the group permissions for the workspace using changeset.

Declaration

void SetItemGroupPermissions(int workspaceId, int itemId, int groupId, GroupPermissionsChangeset groupPermissionsChangeset)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.
System.Int32	groupId	The group ID.
GroupPermissionsChangeset	groupPermissionsChangeset	The group permissions changeset.

Examples

int workspaceID = 123456;
int itemID = 654321;
string permissionName = "Document";
int groupID = 765432;

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

_itemPermissionService.SetItemGroupPermissions(workspaceID, itemID, groupID, groupPermissionsChangeset);

| Improve this Doc View Source

SetItemGroupPermissions(Int32, Int32, Int32, Action<GroupPermissionsChangeset>)

Sets the group permissions for the workspace using changeset setter.

Declaration

void SetItemGroupPermissions(int workspaceId, int itemId, int groupId, Action<GroupPermissionsChangeset> groupPermissionsChangesetSetter)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item 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 itemID = 654321;
string permissionName = "Document";
int groupID = 765432;

_itemPermissionService.SetItemGroupPermissions(workspaceID, itemID, groupID, x => x.ObjectPermissions[permissionName].Set(ObjectPermissionKinds.View));

| Improve this Doc View Source

SetItemGroupPermissions(Int32, Int32, String, GroupPermissionsChangeset)

Sets the group permissions for the workspace using changeset.

Declaration

void SetItemGroupPermissions(int workspaceId, int itemId, string groupName, GroupPermissionsChangeset groupPermissionsChangeset)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item ID.
System.String	groupName	The group name.
GroupPermissionsChangeset	groupPermissionsChangeset	The group permissions changeset.

Examples

int workspaceID = 123456;
int itemID = 654321;
string permissionName = "Document";
string groupName = "Some group name";

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

_itemPermissionService.SetItemGroupPermissions(workspaceID, itemID, groupName, groupPermissionsChangeset);

| Improve this Doc View Source

SetItemGroupPermissions(Int32, Int32, String, Action<GroupPermissionsChangeset>)

Sets the group permissions for the workspace using changeset setter.

Declaration

void SetItemGroupPermissions(int workspaceId, int itemId, string groupName, Action<GroupPermissionsChangeset> groupPermissionsChangesetSetter)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item 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;
int itemID = 654321;
string permissionName = "Document";
string groupName = "Some group name";

_itemPermissionService.SetItemGroupPermissions(workspaceID, itemID, groupName, x => x.ObjectPermissions[permissionName].Set(ObjectPermissionKinds.View));

| Improve this Doc View Source

SetItemLevelSecurity(Int32, Int32, Boolean)

Sets the level security for the specified item.

Declaration

void SetItemLevelSecurity(int workspaceId, int itemId, bool isEnabled)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	itemId	The item id.
System.Boolean	isEnabled	The value which indicating whether edit this item turned on.

Examples

int workspaceID = 123456;
int itemID = 654321;
bool isEnabled = true;

_itemPermissionService.SetItemLevelSecurity(workspaceID, itemID, isEnabled);