Class SecurityRole
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class SecurityRole : SecurityEntity
- Inheritance
-
objectSecurityRole
Properties
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
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.
ExtendedDescription
public override string ExtendedDescription { get; }
Property Value
- string
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
MemberCount
Returns the number of members in this role.
public int MemberCount { get; }
Property Value
- int
NotificationGroups
The NotificationGroups representing this user.
public NotificationGroupCollection NotificationGroups { get; }
Property Value
Methods
GetMembers(ObjectFetchOptions)
Gets all members of the role
public SecurityEntityCollection GetMembers(ObjectFetchOptions options)
Parameters
| Name | Type | Description |
|---|---|---|
options |
ObjectFetchOptions |
Returns
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
| Name | Type | Description |
|---|---|---|
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
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.
- See Also
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- SecurityEntity.Name
- SecurityEntity.Description
- SecurityEntity.IsSystem
- SecurityEntity.Roles
- SecurityEntity.GetPermissions()
- ADTIndependentObject.Refresh()
- ADTIndependentObject.Revert()
- ADTIndependentObject.Save()
- ADTIndependentObject.SaveWithAuditOrSnapshot(ChangeLogParameters)
- ADTIndependentObject.Save(out MessageCollection)
- ADTIndependentObject.SaveWithAuditOrSnapshot(ChangeLogParameters, out MessageCollection)
- ADTIndependentObject.Delete()
- ADTIndependentObject.DeleteWithAuditOrSnapshot(ChangeLogParameters)
- ADTIndependentObject.GetSecurityDescriptor()
- ADTIndependentObject.ReplaceObjectReferences(string[], bool, int, IEnumerable<OID>, ADTObject, bool, ChangeLogParameters)
- ADTIndependentObject.GetObjectReferences(string[], bool, int)
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.CanPerform(SecurityPermission)
- ADTObject.Duplicate()
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.Validate(MessageCollection)
- ADTObject.SupportedSecurityActions
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)