This topic has not yet been rated - Rate this topic

Role Class

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

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

C++

JScript

Copy


[GuidAttribute("28199D46-92B9-47a0-AA19-4ECF2498F30F")]
public sealed class Role : MajorObject, IMajorObject, 
	INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable

The Role type exposes the following members.

Constructors

	Name	Description
	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
	Annotations	Gets the collection object of all annotations to current object. (Inherited from MajorObject.)
	CanRaiseEvents	(Inherited from Component.)
	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.)
	DesignMode	(Inherited from Component.)
	Events	(Inherited from Component.)
	FriendlyName	Returns a user-friendly name. (Inherited from NamedComponent.)
	ID	(Inherited from NamedComponent.)
	IsLoaded	Infrastructure. (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	(Inherited from NamedComponent.)
	OwningCollection	Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
	Parent	Infrastructure. (Inherited from ModelComponent.)
	Site	Infrastructure. (Inherited from NamedComponent.)
	SiteID	Infrastructure. (Inherited from NamedComponent.)

Top

Methods

	Name	Description
	AddToContainer	Infrastructure. (Inherited from ModelComponent.)
	AfterInsert	Infrastructure. (Inherited from ModelComponent.)
	AfterMove	Infrastructure. (Inherited from ModelComponent.)
	AfterRemove	Infrastructure. (Inherited from ModelComponent.)
	BeforeRemove	Infrastructure. (Inherited from ModelComponent.)
	Clone()	Creates a new full copy of an object.
	Clone(Boolean)	Infrastructure. (Inherited from MajorObject.)
	CopyTo(ModelComponent)	Infrastructure. (Inherited from ModelComponent.)
	CopyTo(NamedComponent)	Infrastructure. (Inherited from NamedComponent.)
	CopyTo(Role)	Copies a Role object to the specified object.
	CopyTo(MajorObject, Boolean)	Infrastructure. (Inherited from MajorObject.)
	CreateObjRef	(Inherited from MarshalByRefObject.)
	Dispose()	(Inherited from Component.)
	Dispose(Boolean)	(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.)
	Finalize	(Inherited from Component.)
	GetCreateReferences	Infrastructure. (Inherited from MajorObject.)
	GetDependents	Gets the dependents to the specified Hashtable. (Overrides MajorObject.GetDependents(Hashtable).)
	GetDropDependents	Infrastructure. (Inherited from MajorObject.)
	GetHashCode	(Inherited from Object.)
	GetLifetimeService	(Inherited from MarshalByRefObject.)
	GetReferences	Infrastructure. (Inherited from MajorObject.)
	GetService	(Inherited from Component.)
	GetType	(Inherited from Object.)
	GetUpdateOverwrites	Infrastructure. (Inherited from MajorObject.)
	InitializeLifetimeService	(Inherited from MarshalByRefObject.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(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. (Inherited from ModelComponent.)
	Reset	Infrastructure. (Inherited from NamedComponent.)
	Submit()	Infrastructure. (Inherited from ModelComponent.)
	Submit(Boolean)	Infrastructure. (Inherited from ModelComponent.)
	ToString	(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)	(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)	(Inherited from MajorObject.)
	Validate(ValidationErrorCollection, Boolean, ServerEdition)	(Inherited from NamedComponent.)
	Validate(ValidationResultCollection, ValidationOptions, ServerEdition)	(Inherited from MajorObject.)

Top

Events

	Name	Description
	Disposed	(Inherited from Component.)

Top

Explicit Interface Implementations

	Name	Description
	ICloneable.Clone	Creates a new copy of the object instance.
	IDeserializationCallback.OnDeserialization	(Inherited from MajorObject.)
	IFormattable.ToString	(Inherited from NamedComponent.)
	IDeserializationStartCallback.OnDeserializationBegin	(Inherited from MajorObject.)
	IHostableComponent.Host	(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	(Inherited from ModelComponent.)
	IModelComponent.OwningCollection	(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.

Reference

Microsoft.AnalysisServices Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ