Class NSRoleEntity

Syntax

Constructors

NSRoleEntity()

Initializes a new instance of the NSRoleEntity class.

Introduced or updated in version: 7.5

Declaration

NSRoleEntity

Methods

GetCreated()

Introduced or updated in version: 7.5

Declaration

DateTime GetCreated()

Returns

Type	Description
DateTime	Registered when.

Examples

NSRoleEntity thing;
DateTime created = thing.GetCreated();

GetCreatedBy()

Introduced or updated in version: 7.5

Declaration

NSAssociate GetCreatedBy()

Returns

Type	Description
NSAssociate	Created by user.

Examples

NSRoleEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();

GetDataRights()

Introduced or updated in version: 7.5

Declaration

NSDataRights GetDataRights()

Returns

Type	Description
NSDataRights	Data rights matrix, defines role's access to data owned by current user, users in same group, and other users.

Examples

NSRoleEntity thing;
NSDataRights dataRights = thing.GetDataRights();

GetDeleted()

Introduced or updated in version: 7.5

Declaration

Integer GetDeleted()

Returns

Type	Description
Integer	1 if role has been deleted (we do not actually delete).

Examples

NSRoleEntity thing;
Integer deleted = thing.GetDeleted();

GetName()

Introduced or updated in version: 7.5

Declaration

String GetName()

Returns

Type	Description
String	Visible role name.

Examples

NSRoleEntity thing;
String name = thing.GetName();

GetRank()

Introduced or updated in version: 7.5

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Sorting rank of this role in lists.

Examples

NSRoleEntity thing;
Integer rank = thing.GetRank();

GetRoleId()

Introduced or updated in version: 7.5

Declaration

Integer GetRoleId()

Returns

Type	Description
Integer	Primary key.

Examples

NSRoleEntity thing;
Integer roleId = thing.GetRoleId();

GetRoleType()

Introduced or updated in version: 7.5

Declaration

Integer GetRoleType()

Returns

Type	Description
Integer	The role type. See RoleType.

Remarks

Changing this field has no effect, so treat this as a read-only field.

Examples

NSRoleEntity thing;
Integer roleType = thing.GetRoleType();

GetTooltip()

Introduced or updated in version: 7.5

Declaration

String GetTooltip()

Returns

Type	Description
String	Description of the role.

Examples

NSRoleEntity thing;
String tooltip = thing.GetTooltip();

GetUpdated()

Introduced or updated in version: 7.5

Declaration

DateTime GetUpdated()

Returns

Type	Description
DateTime	Last updated when.

Examples

NSRoleEntity thing;
DateTime updated = thing.GetUpdated();

GetUpdatedBy()

Introduced or updated in version: 7.5

Declaration

NSAssociate GetUpdatedBy()

Returns

Type	Description
NSAssociate	Last updated by user.

Examples

NSRoleEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();

GetUseCategories()

Introduced or updated in version: 7.5

Declaration

Integer GetUseCategories()

Returns

Type	Description
Integer	Apply role category membership to users.

Examples

NSRoleEntity thing;
Integer useCategories = thing.GetUseCategories();

SetCreated(DateTime)

Introduced or updated in version: 7.5

Declaration

Void SetCreated(DateTime created)

Parameters

Type	Name	Description
DateTime	created	Registered when.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
DateTime created;
thing.SetCreated(created);

SetCreatedBy(NSAssociate)

Introduced or updated in version: 7.5

Declaration

Void SetCreatedBy(NSAssociate createdBy)

Parameters

Type	Name	Description
NSAssociate	createdBy	Created by user.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);

SetDataRights(NSDataRights)

Introduced or updated in version: 7.5

Declaration

Void SetDataRights(NSDataRights dataRights)

Parameters

Type	Name	Description
NSDataRights	dataRights	Data rights matrix, defines role's access to data owned by current user, users in same group, and other users.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
NSDataRights dataRights;
thing.SetDataRights(dataRights);

SetDeleted(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetDeleted(Integer deleted)

Parameters

Type	Name	Description
Integer	deleted	1 if role has been deleted (we do not actually delete).

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
Integer deleted;
thing.SetDeleted(deleted);

SetName(String)

Introduced or updated in version: 7.5

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	Visible role name.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
String name;
thing.SetName(name);

SetRank(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Sorting rank of this role in lists.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
Integer rank;
thing.SetRank(rank);

SetRoleId(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetRoleId(Integer roleId)

Parameters

Type	Name	Description
Integer	roleId	Primary key.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
Integer roleId;
thing.SetRoleId(roleId);

SetRoleType(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetRoleType(Integer roleType)

Parameters

Type	Name	Description
Integer	roleType	The role type. Note that changing this field has no effect, so treat this as a read-only field. See RoleType.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
Integer roleType;
thing.SetRoleType(roleType);

SetTooltip(String)

Introduced or updated in version: 7.5

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	Description of the role.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
String tooltip;
thing.SetTooltip(tooltip);

SetUpdated(DateTime)

Introduced or updated in version: 7.5

Declaration

Void SetUpdated(DateTime updated)

Parameters

Type	Name	Description
DateTime	updated	Last updated when.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
DateTime updated;
thing.SetUpdated(updated);

SetUpdatedBy(NSAssociate)

Introduced or updated in version: 7.5

Declaration

Void SetUpdatedBy(NSAssociate updatedBy)

Parameters

Type	Name	Description
NSAssociate	updatedBy	Last updated by user.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);

SetUseCategories(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetUseCategories(Integer useCategories)

Parameters

Type	Name	Description
Integer	useCategories	Apply role category membership to users.

Returns

Type	Description
Void

Examples

NSRoleEntity thing;
Integer useCategories;
thing.SetUseCategories(useCategories);