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
Public method Role() Initializes a new instance of the Role class using the default values.
Public method Role(String) Initializes a new instance of Role using a name.
Public method Role(String, String) Initializes a new instance of Role using a name and an identifier.

Top

Properties

  Name Description
Public property Annotations Gets the collection object of all annotations to current object. (Inherited from MajorObject.)
Protected property CanRaiseEvents (Inherited from Component.)
Public property Container (Inherited from Component.)
Public property CreatedTimestamp Gets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public property Description Gets or sets a description string of current object. (Inherited from MajorObject.)
Protected property DesignMode (Inherited from Component.)
Protected property Events (Inherited from Component.)
Protected property FriendlyName (Inherited from NamedComponent.)
Public property ID (Inherited from NamedComponent.)
Public property IsLoaded Infrastructure. (Inherited from MajorObject.)
Protected property KeyForCollection (Inherited from NamedComponent.)
Public property LastSchemaUpdate Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public property Members Gets the Members associated with a Role.
Public property Name (Inherited from NamedComponent.)
Public property OwningCollection Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public property Parent Infrastructure. (Inherited from ModelComponent.)
Public property Site (Inherited from NamedComponent.)
Public property SiteID (Inherited from NamedComponent.)

Top

Methods

  Name Description
Protected method AddToContainer Infrastructure. (Inherited from ModelComponent.)
Protected method AfterInsert Infrastructure. (Inherited from ModelComponent.)
Protected method AfterMove Infrastructure. (Inherited from ModelComponent.)
Protected method AfterRemove Infrastructure. (Inherited from ModelComponent.)
Protected method BeforeRemove Infrastructure. (Inherited from ModelComponent.)
Public method Clone() Creates a new full copy of an object.
Protected method Clone(Boolean) Infrastructure. (Inherited from MajorObject.)
Protected method CopyTo(ModelComponent) Infrastructure. (Inherited from ModelComponent.)
Protected method CopyTo(NamedComponent) (Inherited from NamedComponent.)
Public method CopyTo(Role) Copies a Role object to the specified object.
Protected method CopyTo(MajorObject, Boolean) Infrastructure. (Inherited from MajorObject.)
Public method CreateObjRef (Inherited from MarshalByRefObject.)
Public method Dispose() (Inherited from Component.)
Protected method Dispose(Boolean) (Inherited from Component.)
Public method Drop() Removes current object and updates server. (Inherited from MajorObject.)
Public method Drop(DropOptions) Removes current object and updates server using specified options. (Inherited from MajorObject.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Component.)
Protected method GetCreateReferences Infrastructure. (Inherited from MajorObject.)
Public method GetDependents (Overrides MajorObject.GetDependents(Hashtable).)
Protected method GetDropDependents Infrastructure. (Inherited from MajorObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService (Inherited from MarshalByRefObject.)
Public method GetReferences Infrastructure. (Inherited from MajorObject.)
Protected method GetService (Inherited from Component.)
Public method GetType (Inherited from Object.)
Public method GetUpdateOverwrites Infrastructure. (Inherited from MajorObject.)
Public method InitializeLifetimeService (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() (Inherited from Object.)
Protected method MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public method Refresh() Updates current object from server definitions. (Inherited from MajorObject.)
Public method Refresh(Boolean) Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Public method Refresh(Boolean, RefreshType) Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Protected method RemoveFromContainer Infrastructure. (Inherited from ModelComponent.)
Protected method Reset (Inherited from NamedComponent.)
Public method Submit() Infrastructure. (Inherited from ModelComponent.)
Public method Submit(Boolean) Infrastructure. (Inherited from ModelComponent.)
Public method ToString (Inherited from NamedComponent.)
Public method Update() Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions) Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode) Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method Validate(ValidationErrorCollection) Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public method Validate(ValidationResultCollection) (Inherited from MajorObject.)
Public method 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.)
Public method Validate(ValidationResultCollection, ValidationOptions) (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean, ServerEdition) (Inherited from NamedComponent.)
Public method Validate(ValidationResultCollection, ValidationOptions, ServerEdition) (Inherited from MajorObject.)

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

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.