Class RoleEntity

Carrier object for RoleEntity. Services for the RoleEntity Carrier is available from the User Agent.

Inheritance
object
RoleEntity
Namespace: SuperOfficeSuperOffice.CRMServices
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class RoleEntity : Carrier
Examples

Get RoleEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new UserAgent();
   var roleEntity = agent.GetRoleEntity( 123 );
}

Find all RoleEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Role", "...", null, "getAllRows eq 1", null, 0, 100 );

Constructors

RoleEntity()

Default constructor

Declaration
public RoleEntity()

Properties

Created

Registered when in UTC.

Declaration
[DataMember]
public virtual DateTime Created { get; set; }
Property Value
Type Description
DateTime

CreatedBy

Created by user

Declaration
[DataMember]
public virtual Associate CreatedBy { get; set; }
Property Value
Type Description
Associate

DataRights

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

Declaration
[DataMember]
public virtual DataRights DataRights { get; set; }
Property Value
Type Description
DataRights

Deleted

1 if role has been deleted (we do not actually delete)

Declaration
[DataMember]
public virtual short Deleted { get; set; }
Property Value
Type Description
short

Name

Visible role name

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string

Rank

Sorting rank of this role in lists

Declaration
[DataMember]
public virtual short Rank { get; set; }
Property Value
Type Description
short

RoleId

Primary key

Declaration
[DataMember]
public virtual int RoleId { get; set; }
Property Value
Type Description
int

RoleType

The role type. Note that changing this field has no effect, so treat this as a read-only field.

Declaration
[DataMember]
public virtual RoleType RoleType { get; set; }
Property Value
Type Description
SuperOffice.Data.RoleType

Tooltip

Description of the role.

Declaration
[DataMember]
public virtual string Tooltip { get; set; }
Property Value
Type Description
string

Updated

Last updated when in UTC.

Declaration
[DataMember]
public virtual DateTime Updated { get; set; }
Property Value
Type Description
DateTime

UpdatedBy

Last updated by user

Declaration
[DataMember]
public virtual Associate UpdatedBy { get; set; }
Property Value
Type Description
Associate

UseCategories

Apply role category membership to users

Declaration
[DataMember]
public virtual short UseCategories { get; set; }
Property Value
Type Description
short

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.

See Also