Table of Contents

Class SecurityRole

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

A security role represents a set of permissions that can be assigned to a SecurityLogin or to another SecurityRole.

public sealed class SecurityRole : SecurityEntity
Inheritance
object
SecurityRole

Properties

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

MemberCount

Returns the number of members in this role.

public int MemberCount { get; }

Property Value

int

Name

The name of the role

public override string Name { get; set; }

Property Value

string

Remarks

The role name must be unique

Methods

GetMembers(ObjectFetchOptions)

Gets all members of the role

public SecurityEntityCollection GetMembers(ObjectFetchOptions options)

Parameters

NameTypeDescription
options ObjectFetchOptions

Options controlling the fetch operation

Returns

SecurityEntityCollection

Remarks

This is a read-only collection. To assign a Login to a Role, add the Role to the Login's Roles collection.

GetMembersWithPaging(ObjectFetchOptions, int, ref bool)

Gets all members of the role, with options

public SecurityEntityCollection GetMembersWithPaging(ObjectFetchOptions options, int pageSize, ref bool restartPaging)

Parameters

NameTypeDescription
options ObjectFetchOptions

Options that control how objects are returned.
pageSize int

Specfies the number of objects to return in each call. Set to 0 to return all objects. See Remarks.
restartPaging bool

On input, indicates whether to start a new paging operation (true) or continue a previous paging operation (false). On return, indicates whether all records have been returned (true) or more records remain (false). See Remarks.

Returns

SecurityEntityCollection

Remarks

This is a read-only collection. To assign a Login to a Role, add the Role to the Login's Roles collection.

Paging

To fetch objects in pages (a maximum number of objects is returned in each request), set the pageSize to the maximum number requested and set restartPaging to true. On return, restartPaging will be false if there are more objects that can be fetched. To fetch the remaining pages of objects, continue to call the method, leaving restartPaging set to false, until restartPaging is true on return. At this point, all available objects have been returned.

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members