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.)
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 FriendlyName Returns a user-friendly name. (Inherited from NamedComponent.)
Public property ID Gets or sets the identifier of the component. (Inherited from NamedComponent.)
Public property IsLoaded Infrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.)
Protected property KeyForCollection Returns the key used in collections. (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 Gets or sets the name of the component. (Inherited from NamedComponent.)
Public property OwningCollection Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public property Parent Infrastructure. Gets the IModelComponent object that is the parent of the ModelComponent object. (Inherited from ModelComponent.)
Public property Site Infrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
Public property SiteID Infrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)

Top

Methods

  Name Description
Protected method AddToContainer Infrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
Protected method AfterInsert Infrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
Protected method AfterMove Infrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
Protected method AfterRemove Infrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.)
Protected method BeforeRemove Infrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.)
Public method Clone() Creates a new full copy of an object.
Protected method Clone(Boolean) Infrastructure. Creates a new copy of the MajorObject object. (Inherited from MajorObject.)
Public method CopyTo(Role) Copies a Role object to the specified object.
Protected method CopyTo(MajorObject, Boolean) Infrastructure. Copies a MajorObject object to the specified destination. (Inherited from MajorObject.)
Public method CreateObjRef Security Critical. (Inherited from MarshalByRefObject.)
Public method Dispose (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 GetCreateReferences Infrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.)
Public method GetDependents Gets the dependents to the specified Hashtable. (Overrides MajorObject.GetDependents(Hashtable).)
Protected method GetDropDependents Infrastructure. Gets the drop dependents. (Inherited from MajorObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService Security Critical. (Inherited from MarshalByRefObject.)
Public method GetReferences Infrastructure. Gets the objects that the MajorObject references. (Inherited from MajorObject.)
Public method GetType (Inherited from Object.)
Public method GetUpdateOverwrites Infrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.)
Public method InitializeLifetimeService Security Critical. (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. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
Public method Submit() Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public method Submit(Boolean) Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public method ToString Returns a string containing the name of the component. (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) Indicates whether the MajorObject is valid. (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) Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean, ServerEdition) Determines whether the NamedComponent is valid. (Inherited from NamedComponent.)
Public method Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Indicates whether the MajorObject is valid. (Inherited from MajorObject.)

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICloneable.Clone Creates a new copy of the object instance.
Explicit interface implemetationPrivate method IDeserializationCallback.OnDeserialization Runs when the entire object graph has been deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate method IFormattable.ToString Formats the value of the current instance using the specified format. (Inherited from NamedComponent.)
Explicit interface implemetationPrivate method IDeserializationStartCallback.OnDeserializationBegin Runs when the entire object graph starts to deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate property IHostableComponent.Host Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IMajorObject.BaseType Gets the base type implementation of the Role.
Explicit interface implemetationPrivate method IMajorObject.CreateBody Creates a new body for the Role.
Explicit interface implemetationPrivate method IMajorObject.DependsOn Determines whether the Role depends on an object.
Explicit interface implemetationPrivate property IMajorObject.ObjectReference Gets the object reference implementation of the Role.
Explicit interface implemetationPrivate property IMajorObject.ParentDatabase Gets the parent database referred by the Role.
Explicit interface implemetationPrivate property IMajorObject.ParentServer Gets the Server object that is the parent of the Role object.
Explicit interface implemetationPrivate property IMajorObject.Path Gets the path implementation of the Role.
Explicit interface implemetationPrivate method IMajorObject.WriteRef Writes a reference for the Role.
Explicit interface implemetationPrivate property IModelComponent.FriendlyPath Gets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property 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.

See Also

Reference

Microsoft.AnalysisServices Namespace