Role Role Role Class

Definition

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

public ref class Role sealed : Microsoft::AnalysisServices::Core::Role, ICloneable, IDisposable, Microsoft::AnalysisServices::IMajorObject
[System.ComponentModel.Design.Serialization.DesignerSerializer("Microsoft.DataWarehouse.Serialization.DesignXmlSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91", "Microsoft.DataWarehouse.Serialization.DesignerComponentSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91")]
[System.ComponentModel.Design.Serialization.DesignerSerializer("Microsoft.DataWarehouse.Serialization.OnlineComponentSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91", "Microsoft.DataWarehouse.Serialization.OnlineComponentSerializer, Microsoft.DataWarehouse, PublicKeyToken=89845dcd8080cc91")]
[System.ComponentModel.Designer("Microsoft.AnalysisServices.Design.RoleDesigner,Microsoft.AnalysisServices.Design", typeof(System.ComponentModel.Design.IRootDesigner))]
[System.ComponentModel.DesignerCategory("Designer")]
[System.Runtime.InteropServices.Guid("28199D46-92B9-47a0-AA19-4ECF2498F30F")]
[System.Xml.Serialization.XmlRoot(Namespace="http://schemas.microsoft.com/analysisservices/2003/engine")]
public sealed class Role : Microsoft.AnalysisServices.Core.Role, ICloneable, IDisposable, Microsoft.AnalysisServices.IMajorObject
Public NotInheritable Class Role
Inherits Role
Implements ICloneable, IDisposable, IMajorObject
Inheritance
Attributes
Implements

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.

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 a name.

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

Initializes a new instance of Role using a name and an identifier.

Methods

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

Adds a 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()

Creates a new full copy of an 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 a MajorObject to the specified destination. Do not reference this member directly in your code. It supports the Analysis Services infrastructure and will be hidden in a future release.

(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 a Role object to the specified object.

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 current object from server definitions.

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

Updates current object from server definitions and loaded dependent objects if specified.

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

Updates current object from server definitions and loaded dependent objects if specified.

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

Removes a 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 containing the name of the 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()

Creates a new copy of the object instance.

IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object)

Runs when the entire object graph has been deserialized.

(Inherited from MajorObject)
IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object)

Runs when the entire object graph starts to deserialized.

(Inherited from MajorObject)
IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider)

Formats the value of the current instance using the specified format.

(Inherited from NamedComponent)
IMajorObject.BaseType IMajorObject.BaseType IMajorObject.BaseType

Gets the base type implementation of the Role.

IMajorObject.CreateBody() IMajorObject.CreateBody() IMajorObject.CreateBody()

Creates a new body for the Role.

IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject)

Determines whether the Role depends on an object.

IMajorObject.ObjectReference IMajorObject.ObjectReference IMajorObject.ObjectReference

Gets the object reference implementation of the Role.

IMajorObject.ParentDatabase IMajorObject.ParentDatabase IMajorObject.ParentDatabase

Gets the parent database referred by the Role.

IMajorObject.ParentServer IMajorObject.ParentServer IMajorObject.ParentServer

Gets the Server object that is the parent of the Role object.

IMajorObject.Path IMajorObject.Path IMajorObject.Path

Gets the path implementation of the Role.

IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter)

Writes a reference for the Role.

Properties

Annotations Annotations Annotations

Gets the collection object of all annotations to current 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 a description string of current object.

(Inherited from MajorObject)
ExternalMembers ExternalMembers ExternalMembers

Internal only. This API is part of the Analysis Services infrastructure and is not intended to be called directly from your code.

(Inherited from Role)
FriendlyName FriendlyName FriendlyName

Returns a user-friendly name.

(Inherited from NamedComponent)
ID ID ID

Gets or sets the identifier of the component.

(Inherited from NamedComponent)
IHostableComponent.Host IHostableComponent.Host IHostableComponent.Host

Gets or sets the IServiceProvider that is the host of the ModelComponent.

(Inherited from ModelComponent)
IModelComponent.FriendlyPath IModelComponent.FriendlyPath IModelComponent.FriendlyPath

Gets a friendly path for the ModelComponent.

(Inherited from ModelComponent)
IModelComponent.OwningCollection IModelComponent.OwningCollection IModelComponent.OwningCollection

Gets or sets the collection that owns the current object.

(Inherited from ModelComponent)
IsLoaded IsLoaded IsLoaded

Gets a value that indicates whether MajorObject have been loaded.

(Inherited from MajorObject)
KeyForCollection KeyForCollection KeyForCollection

Returns 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 Microsoft.AnalysisServices.Role.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 of 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