Role Role Role Class

Definition

Represents the level of security associated with a group of users. This class cannot be inherited.

[System.Runtime.InteropServices.Guid("28199D46-92B9-47a0-AA19-4ECF2498F30F")]
public sealed class Role : Microsoft.AnalysisServices.Core.Role, ICloneable, IDisposable, Microsoft.AnalysisServices.IMajorObject
type Role = class
    inherit Role
    interface IMajorObject
    interface INamedComponent
    interface IModelComponent
    interface IComponent
    interface IDisposable
    interface ICloneable
Public NotInheritable Class Role
Inherits Role
Implements ICloneable, IDisposable, IMajorObject
Inheritance
Attributes
Implements

Constructors

Role() Role() Role()

Initializes a new instance of the Role class using the default values.

Role(String) Role(String) Role(String)

Initializes a new instance of Role using the specified name.

Role(String, String) Role(String, String) Role(String, String)

Initializes a new instance of Role using the specified name and identifier.

Methods

AddToContainer(IContainer) AddToContainer(IContainer) AddToContainer(IContainer)

Adds the ModelComponent object to the specified container.

(Inherited from ModelComponent)
AfterInsert(Int32) AfterInsert(Int32) AfterInsert(Int32)

Displays a ModelComponent object after added to the specified index.

(Inherited from ModelComponent)
AfterMove(Int32, Int32) AfterMove(Int32, Int32) AfterMove(Int32, Int32)

Displays a ModelComponent object after moving to the specified index.

(Inherited from ModelComponent)
AfterRemove(ModelComponentCollection) AfterRemove(ModelComponentCollection) AfterRemove(ModelComponentCollection)

Displays a ModelComponentCollection after a ModelComponent object is removed.

(Inherited from ModelComponent)
BeforeRemove(Boolean) BeforeRemove(Boolean) BeforeRemove(Boolean)

Removes the ModelComponent object before the cleanup.

(Inherited from ModelComponent)
Clone() Clone() Clone()

Returns a clone of the object.

Clone(Boolean) Clone(Boolean) Clone(Boolean)

Creates a new copy of the MajorObject object.

(Inherited from MajorObject)
CopyTo(MajorObject, Boolean) CopyTo(MajorObject, Boolean) CopyTo(MajorObject, Boolean)

Copies the Role to a MajorObject to the specified destination.

(Inherited from Role)
CopyTo(ModelComponent) CopyTo(ModelComponent) CopyTo(ModelComponent)

Copies a ModelComponent object to the specified object.

(Inherited from ModelComponent)
CopyTo(NamedComponent) CopyTo(NamedComponent) CopyTo(NamedComponent)

Copies a NamedComponent object to the specified object.

(Inherited from NamedComponent)
CopyTo(Role) CopyTo(Role) CopyTo(Role)

Copies the content of this object to another object (the destination).

Drop() Drop() Drop()

Removes current object and updates server.

(Inherited from MajorObject)
Drop(DropOptions) Drop(DropOptions) Drop(DropOptions)

Removes current object and updates server using specified options.

(Inherited from MajorObject)
Drop(DropOptions, XmlaWarningCollection) Drop(DropOptions, XmlaWarningCollection) 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) Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection) 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) Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection, Boolean) 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)
GetCreateReferences(Hashtable, Boolean, Boolean) GetCreateReferences(Hashtable, Boolean, Boolean) GetCreateReferences(Hashtable, Boolean, Boolean)

Gets a Hashtable to create references.

(Inherited from MajorObject)
GetDependents(Hashtable) GetDependents(Hashtable) GetDependents(Hashtable)

Gets the dependents to the specified Hashtable.

GetDropDependents(Hashtable, Hashtable) GetDropDependents(Hashtable, Hashtable) GetDropDependents(Hashtable, Hashtable)

Gets the drop dependents.

(Inherited from MajorObject)
GetReferences(Hashtable, Boolean) GetReferences(Hashtable, Boolean) GetReferences(Hashtable, Boolean)

Gets the objects that the MajorObject references.

(Inherited from MajorObject)
GetUpdateOverwrites(Boolean) GetUpdateOverwrites(Boolean) GetUpdateOverwrites(Boolean)

Gets the Hashtable object that overwrites the updated MajorObject.

(Inherited from MajorObject)
Refresh() Refresh() Refresh()

Updates the object from server definitions.

(Inherited from MajorObject)
Refresh(Boolean) Refresh(Boolean) Refresh(Boolean)

Updates the object from server definitions, as well as loaded dependent objects [if specified].

(Inherited from MajorObject)
Refresh(Boolean, RefreshType) Refresh(Boolean, RefreshType) Refresh(Boolean, RefreshType)

Updates the object from server definitions, as well as loaded dependent objects [if specified].

(Inherited from MajorObject)
RemoveFromContainer(IContainer) RemoveFromContainer(IContainer) RemoveFromContainer(IContainer)

Removes the ModelComponent object from the specified container.

(Inherited from ModelComponent)
Reset() Reset() Reset()

Resets the component to its initial state.

(Inherited from NamedComponent)
Submit() Submit() Submit()

Submits a ModelComponent object.

(Inherited from ModelComponent)
Submit(Boolean) Submit(Boolean) Submit(Boolean)

Submits a ModelComponent object.

(Inherited from ModelComponent)
ToString() ToString() ToString()

Returns a string representing the named-component.

(Inherited from NamedComponent)
Update() Update() Update()

Updates server definition of current object to actual values using the default values to update dependent objects.

(Inherited from MajorObject)
Update(UpdateOptions) Update(UpdateOptions) 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) Update(UpdateOptions, UpdateMode) 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) Update(UpdateOptions, UpdateMode, XmlaWarningCollection) 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) Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection) 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) Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection, Boolean) 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) Validate(ValidationErrorCollection) Validate(ValidationErrorCollection)

Validates the element to which it is appended; returns any errors encountered in a collection.

(Inherited from ModelComponent)
Validate(ValidationErrorCollection, Boolean) Validate(ValidationErrorCollection, Boolean) 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(ValidationErrorCollection, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition)

Determines whether the NamedComponent is valid.

(Inherited from NamedComponent)
Validate(ValidationResultCollection) Validate(ValidationResultCollection) Validate(ValidationResultCollection)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions) Validate(ValidationResultCollection, ValidationOptions) Validate(ValidationResultCollection, ValidationOptions)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Validate(ValidationResultCollection, ValidationOptions, ServerEdition)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)

Explicit Interface Implementations

ICloneable.Clone() ICloneable.Clone() ICloneable.Clone()
IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object) Inherited from MajorObject
IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object) Inherited from MajorObject
IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) Inherited from NamedComponent
IMajorObject.BaseType IMajorObject.BaseType IMajorObject.BaseType
IMajorObject.CreateBody() IMajorObject.CreateBody() IMajorObject.CreateBody()
IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject)
IMajorObject.ObjectReference IMajorObject.ObjectReference IMajorObject.ObjectReference
IMajorObject.ParentDatabase IMajorObject.ParentDatabase IMajorObject.ParentDatabase
IMajorObject.ParentServer IMajorObject.ParentServer IMajorObject.ParentServer
IMajorObject.Path IMajorObject.Path IMajorObject.Path
IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter)

Properties

Annotations Annotations Annotations

Gets the collection of all annotations associated with the major object.

(Inherited from MajorObject)
CreatedTimestamp CreatedTimestamp CreatedTimestamp

Gets or sets the date and time of the creation of the object.

(Inherited from MajorObject)
Description Description Description

Gets or sets the description of major object.

(Inherited from MajorObject)
ExternalMembers ExternalMembers ExternalMembers

Gets the collection of external members associated with the role.

(Inherited from Role)
FriendlyName FriendlyName FriendlyName

Gets a user-friendly name for the component.

(Inherited from NamedComponent)
ID ID ID

Gets or sets the identifier of the component.

(Inherited from NamedComponent)
IHostableComponent.Host IHostableComponent.Host IHostableComponent.Host Inherited from ModelComponent
IModelComponent.FriendlyPath IModelComponent.FriendlyPath IModelComponent.FriendlyPath Inherited from ModelComponent
IModelComponent.OwningCollection IModelComponent.OwningCollection IModelComponent.OwningCollection Inherited from ModelComponent
IsLoaded IsLoaded IsLoaded

Gets a value that indicates whether MajorObject have been loaded.

(Inherited from MajorObject)
KeyForCollection KeyForCollection KeyForCollection

Gets the key used in collections.

(Inherited from NamedComponent)
LastSchemaUpdate LastSchemaUpdate LastSchemaUpdate

Gets or sets the date and time when current object schema was last updated.

(Inherited from MajorObject)
Members Members Members

Gets the Members, all of which are Windows security principles (user or group accounts), associated with a Role.

(Inherited from Role)
Name Name Name

Gets or sets the name of the component.

(Inherited from NamedComponent)
OwningCollection OwningCollection OwningCollection

Gets or sets the collection that contains the ModelComponent.

(Inherited from ModelComponent)
Parent Parent Parent

Gets the IModelComponent object that is the parent of the ModelComponent object.

(Inherited from ModelComponent)
Site Site Site

Gets or sets the site associated with the component.

(Inherited from NamedComponent)
SiteID SiteID SiteID

Gets or sets the identifier for the site associated with the component.

(Inherited from NamedComponent)

Fields

MaxIDLength MaxIDLength MaxIDLength

Specifies the maximum length of the identifier.

(Inherited from NamedComponent)
MaxNameLength MaxNameLength MaxNameLength

Specifies the maximum length of the name.

(Inherited from NamedComponent)

Applies to