Role Class
Represents the level of security associated with a group of users. This class cannot be inherited.
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
Microsoft.AnalysisServices.ModelComponent
Microsoft.AnalysisServices.NamedComponent
Microsoft.AnalysisServices.MajorObject
Microsoft.AnalysisServices.Role
Namespace: Microsoft.AnalysisServices
Assembly: Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)
Syntax
'Declaration
<GuidAttribute("28199D46-92B9-47a0-AA19-4ECF2498F30F")> _
Public NotInheritable Class Role _
Inherits MajorObject _
Implements IMajorObject, INamedComponent, IModelComponent, IComponent, _
IDisposable, ICloneable
'Usage
Dim instance As Role
[GuidAttribute("28199D46-92B9-47a0-AA19-4ECF2498F30F")]
public sealed class Role : MajorObject, IMajorObject,
INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable
[GuidAttribute(L"28199D46-92B9-47a0-AA19-4ECF2498F30F")]
public ref class Role sealed : public MajorObject,
IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable,
ICloneable
[<SealedAttribute>]
[<GuidAttribute("28199D46-92B9-47a0-AA19-4ECF2498F30F")>]
type Role =
class
inherit MajorObject
interface IMajorObject
interface INamedComponent
interface IModelComponent
interface IComponent
interface IDisposable
interface ICloneable
end
public final class Role extends MajorObject implements IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable
The Role type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Role() | Initializes a new instance of the Role class using the default values. |
|
Role(String) | Initializes a new instance of Role using a name. |
|
Role(String, String) | Initializes a new instance of Role using a name and an identifier. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Annotations | Gets the collection object of all annotations to current object. (Inherited from MajorObject.) |
|
Container | (Inherited from Component.) |
|
CreatedTimestamp | Gets or sets the date and time of the creation of the object. (Inherited from MajorObject.) |
|
Description | Gets or sets a description string of current object. (Inherited from MajorObject.) |
.gif "Protected property") |
FriendlyName | Returns a user-friendly name. (Inherited from NamedComponent.) |
|
ID | Gets or sets the identifier of the component. (Inherited from NamedComponent.) |
|
IsLoaded | Infrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.) |
|
KeyForCollection | Returns the key used in collections. (Inherited from NamedComponent.) |
|
LastSchemaUpdate | Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.) |
|
Members | Gets the Members associated with a Role. |
|
Name | Gets or sets the name of the component. (Inherited from NamedComponent.) |
|
OwningCollection | Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.) |
|
Parent | Infrastructure. Gets the IModelComponent object that is the parent of the ModelComponent object. (Inherited from ModelComponent.) |
|
Site | Infrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.) |
|
SiteID | Infrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Protected method") |
AddToContainer | Infrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.) |
|
AfterInsert | Infrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.) |
|
AfterMove | Infrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.) |
|
AfterRemove | Infrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.) |
|
BeforeRemove | Infrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.) |
|
Clone() | Creates a new full copy of an object. |
|
Clone(Boolean) | Infrastructure. Creates a new copy of the MajorObject object. (Inherited from MajorObject.) |
|
CopyTo(Role) | Copies a Role object to the specified object. |
|
CopyTo(MajorObject, Boolean) | Infrastructure. Copies a MajorObject object to the specified destination. (Inherited from MajorObject.) |
|
CreateObjRef | Security Critical. (Inherited from MarshalByRefObject.) |
|
Dispose | (Inherited from Component.) |
|
Drop() | Removes current object and updates server. (Inherited from MajorObject.) |
|
Drop(DropOptions) | Removes current object and updates server using specified options. (Inherited from MajorObject.) |
|
Drop(DropOptions, XmlaWarningCollection) | Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings object. (Inherited from MajorObject.) |
|
Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection) | Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings variable and results for affected objects in operation are returned on specified impactResult variable. (Inherited from MajorObject.) |
|
Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection, Boolean) | Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings variable and results for affected objects in operation are returned on specified impactResult variable. (Inherited from MajorObject.) |
|
Equals | (Inherited from Object.) |
|
GetCreateReferences | Infrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.) |
|
GetDependents | Gets the dependents to the specified Hashtable. (Overrides MajorObject.GetDependents(Hashtable).) |
|
GetDropDependents | Infrastructure. Gets the drop dependents. (Inherited from MajorObject.) |
|
GetHashCode | (Inherited from Object.) |
|
GetLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
GetReferences | Infrastructure. Gets the objects that the MajorObject references. (Inherited from MajorObject.) |
|
GetType | (Inherited from Object.) |
|
GetUpdateOverwrites | Infrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.) |
|
InitializeLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
Refresh() | Updates current object from server definitions. (Inherited from MajorObject.) |
|
Refresh(Boolean) | Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.) |
|
Refresh(Boolean, RefreshType) | Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.) |
|
RemoveFromContainer | Infrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.) |
|
Submit() | Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.) |
|
Submit(Boolean) | Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.) |
|
ToString | Returns a string containing the name of the component. (Inherited from NamedComponent.) |
|
Update() | Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.) |
|
Update(UpdateOptions) | Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.) |
|
Update(UpdateOptions, UpdateMode) | Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.) |
|
Update(UpdateOptions, UpdateMode, XmlaWarningCollection) | Updates server definition of current object to actual values using the specified options to update dependent objects and reports any warnings from operation. (Inherited from MajorObject.) |
|
Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection) | Updates server definition of current object to actual values using specified options to update dependent objects, reports any warnings from operation, and returns affected objects from operation. (Inherited from MajorObject.) |
|
Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection, Boolean) | Updates server definition of current object to actual values using specified options to update dependent objects, reports any warnings from operation, and returns affected objects from operation. If analyzeImpactOnly is true, an impact analysis operation is performed with no update operation. (Inherited from MajorObject.) |
|
Validate(ValidationErrorCollection) | Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.) |
|
Validate(ValidationResultCollection) | Indicates whether the MajorObject is valid. (Inherited from MajorObject.) |
|
Validate(ValidationErrorCollection, Boolean) | Validates the element to which it is appended; returns any errors encountered in a collection. Also contains a parameter to enable return of detailed errors. (Inherited from ModelComponent.) |
|
Validate(ValidationResultCollection, ValidationOptions) | Indicates whether the MajorObject is valid. (Inherited from MajorObject.) |
|
Validate(ValidationErrorCollection, Boolean, ServerEdition) | Determines whether the NamedComponent is valid. (Inherited from NamedComponent.) |
|
Validate(ValidationResultCollection, ValidationOptions, ServerEdition) | Indicates whether the MajorObject is valid. (Inherited from MajorObject.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Disposed | (Inherited from Component.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICloneable.Clone | Creates a new copy of the object instance. |
|
IDeserializationCallback.OnDeserialization | Runs when the entire object graph has been deserialized. (Inherited from MajorObject.) |
|
IFormattable.ToString | Formats the value of the current instance using the specified format. (Inherited from NamedComponent.) |
|
IDeserializationStartCallback.OnDeserializationBegin | Runs when the entire object graph starts to deserialized. (Inherited from MajorObject.) |
.gif "Private property") |
IHostableComponent.Host | Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.) |
|
IMajorObject.BaseType | Gets the base type implementation of the Role. |
|
IMajorObject.CreateBody | Creates a new body for the Role. |
|
IMajorObject.DependsOn | Determines whether the Role depends on an object. |
|
IMajorObject.ObjectReference | Gets the object reference implementation of the Role. |
|
IMajorObject.ParentDatabase | Gets the parent database referred by the Role. |
|
IMajorObject.ParentServer | Gets the Server object that is the parent of the Role object. |
|
IMajorObject.Path | Gets the path implementation of the Role. |
|
IMajorObject.WriteRef | Writes a reference for the Role. |
|
IModelComponent.FriendlyPath | Gets a friendly path for the ModelComponent. (Inherited from ModelComponent.) |
|
IModelComponent.OwningCollection | Gets or sets the collection that owns the current object. (Inherited from ModelComponent.) |
Top
Remarks
A Role may be owned by a Server or by a Database. The definition of the Role includes the users that are members of the Role.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.