Class NSRoleEntity
Constructors
NSRoleEntity()
Initializes a new instance of the NSRoleEntity class.
Declaration
NSRoleEntityMethods
GetCreated()
Declaration
DateTime GetCreated()Examples
NSRoleEntity thing;
DateTime created = thing.GetCreated();Returns
| Type | Description |
| DateTime | Registered when. |
GetCreatedBy()
Declaration
NSAssociate GetCreatedBy()Examples
NSRoleEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();Returns
| Type | Description |
| NSAssociate | Created by user. |
GetDataRights()
Declaration
NSDataRights GetDataRights()Examples
NSRoleEntity thing;
NSDataRights dataRights = thing.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. |
GetDeleted()
Declaration
Integer GetDeleted()Examples
NSRoleEntity thing;
Integer deleted = thing.GetDeleted();Returns
| Type | Description |
| Integer | 1 if role has been deleted (we do not actually delete). |
GetName()
Declaration
String GetName()Examples
NSRoleEntity thing;
String name = thing.GetName();Returns
| Type | Description |
| String | Visible role name. |
GetRank()
Declaration
Integer GetRank()Examples
NSRoleEntity thing;
Integer rank = thing.GetRank();Returns
| Type | Description |
| Integer | Sorting rank of this role in lists. |
GetRoleId()
Declaration
Integer GetRoleId()Examples
NSRoleEntity thing;
Integer roleId = thing.GetRoleId();Returns
| Type | Description |
| Integer | Primary key. |
GetRoleType()
Declaration
Integer GetRoleType()Examples
NSRoleEntity thing;
Integer roleType = thing.GetRoleType();Returns
| Type | Description |
| Integer | The role type. See <xref href="CRMScript.NetServer.RoleType" data-throw-if-not-resolved="false"></xref>. |
GetTooltip()
Declaration
String GetTooltip()Examples
NSRoleEntity thing;
String tooltip = thing.GetTooltip();Returns
| Type | Description |
| String | Description of the role. |
GetUpdated()
Declaration
DateTime GetUpdated()Examples
NSRoleEntity thing;
DateTime updated = thing.GetUpdated();Returns
| Type | Description |
| DateTime | Last updated when. |
GetUpdatedBy()
Declaration
NSAssociate GetUpdatedBy()Examples
NSRoleEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();Returns
| Type | Description |
| NSAssociate | Last updated by user. |
GetUseCategories()
Declaration
Integer GetUseCategories()Examples
NSRoleEntity thing;
Integer useCategories = thing.GetUseCategories();Returns
| Type | Description |
| Integer | Apply role category membership to users. |
SetCreated(DateTime)
Declaration
Void SetCreated(DateTime created)Examples
NSRoleEntity thing;
DateTime created;
thing.SetCreated(created);Parameters
| Type | Name | Description |
| DateTime | created | Registered when. |
Returns
| Type | Description |
| Void |
SetCreatedBy(NSAssociate)
Declaration
Void SetCreatedBy(NSAssociate createdBy)Examples
NSRoleEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);Parameters
| Type | Name | Description |
| NSAssociate | createdBy | Created by user. |
Returns
| Type | Description |
| Void |
SetDataRights(NSDataRights)
Declaration
Void SetDataRights(NSDataRights dataRights)Examples
NSRoleEntity thing;
NSDataRights dataRights;
thing.SetDataRights(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 |
SetDeleted(Integer)
Declaration
Void SetDeleted(Integer deleted)Examples
NSRoleEntity thing;
Integer deleted;
thing.SetDeleted(deleted);Parameters
| Type | Name | Description |
| Integer | deleted | 1 if role has been deleted (we do not actually delete). |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSRoleEntity thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | Visible role name. |
Returns
| Type | Description |
| Void |
SetRank(Integer)
Declaration
Void SetRank(Integer rank)Examples
NSRoleEntity thing;
Integer rank;
thing.SetRank(rank);Parameters
| Type | Name | Description |
| Integer | rank | Sorting rank of this role in lists. |
Returns
| Type | Description |
| Void |
SetRoleId(Integer)
Declaration
Void SetRoleId(Integer roleId)Examples
NSRoleEntity thing;
Integer roleId;
thing.SetRoleId(roleId);Parameters
| Type | Name | Description |
| Integer | roleId | Primary key. |
Returns
| Type | Description |
| Void |
SetRoleType(Integer)
Declaration
Void SetRoleType(Integer roleType)Examples
NSRoleEntity thing;
Integer roleType;
thing.SetRoleType(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 <xref href="CRMScript.NetServer.RoleType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetTooltip(String)
Declaration
Void SetTooltip(String tooltip)Examples
NSRoleEntity thing;
String tooltip;
thing.SetTooltip(tooltip);Parameters
| Type | Name | Description |
| String | tooltip | Description of the role. |
Returns
| Type | Description |
| Void |
SetUpdated(DateTime)
Declaration
Void SetUpdated(DateTime updated)Examples
NSRoleEntity thing;
DateTime updated;
thing.SetUpdated(updated);Parameters
| Type | Name | Description |
| DateTime | updated | Last updated when. |
Returns
| Type | Description |
| Void |
SetUpdatedBy(NSAssociate)
Declaration
Void SetUpdatedBy(NSAssociate updatedBy)Examples
NSRoleEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);Parameters
| Type | Name | Description |
| NSAssociate | updatedBy | Last updated by user. |
Returns
| Type | Description |
| Void |