CollectionItem CollectionItem CollectionItem Class

Definition

public sealed class CollectionItem : Microsoft.SqlServer.Management.Sdk.Sfc.SfcInstance, Microsoft.SqlServer.Management.Common.IAlterable, Microsoft.SqlServer.Management.Common.IMarkForDrop, Microsoft.SqlServer.Management.Common.IRenamable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcAlterable, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcRenamable
type CollectionItem = class
    inherit SfcInstance
    interface ISfcAlterable
    interface IAlterable
    interface ISfcRenamable
    interface IRenamable
    interface IMarkForDrop
Public NotInheritable Class CollectionItem
Inherits SfcInstance
Implements IAlterable, IMarkForDrop, IRenamable, ISfcAlterable, ISfcRenamable
Inheritance
CollectionItemCollectionItemCollectionItem
Implements

Constructors

CollectionItem(CollectionSet, String) CollectionItem(CollectionSet, String) CollectionItem(CollectionSet, String)

Create an instance of a collection item given the collection set and an item name

The parent collection setThe name of the collection item

Properties

AbstractIdentityKey AbstractIdentityKey AbstractIdentityKey Inherited from SfcInstance
CollectionFrequency CollectionFrequency CollectionFrequency

The collection frequency for this item if the set is running in CollectionMode "continuous"

Id Id Id

Collection item id

IdentityKey IdentityKey IdentityKey

Key property

Metadata Metadata Metadata Inherited from SfcInstance
Name Name Name

Collection item name

Parameters Parameters Parameters

An xml fragment representing the specific parameters for this collection item. It has to conform to the schema of the collector type that this item implements

Parent Parent Parent

Parent object in the om hierarchy; CollectionSet

Properties Properties Properties Inherited from SfcInstance
PropertyStorageProvider PropertyStorageProvider PropertyStorageProvider

This property returns the default implementation of SFC for ISfcPropertyStorageProvider interface, it can be overriden in the child classes to return another storage provider (i.e. flat properties list)

(Inherited from SfcInstance)
State State State Inherited from SfcInstance
TypeName TypeName TypeName

The collector type name that this collection item implements

Urn Urn Urn

Create a new Urn string on each request and return it.

(Inherited from SfcInstance)

Methods

Alter() Alter() Alter()

Alter a Collection Item by applying the changes to the configuration store

AlterImpl() AlterImpl() AlterImpl() Inherited from SfcInstance
CheckObjectCreated() CheckObjectCreated() CheckObjectCreated()

To be called from domain for when an API requires the object to be Created Stronger than CheckObjectState

(Inherited from SfcInstance)
CheckObjectState() CheckObjectState() CheckObjectState()

To be called from domain for any access to the object

(Inherited from SfcInstance)
CreateIdentityKey() CreateIdentityKey() CreateIdentityKey() Inherited from SfcInstance
CreateImpl() CreateImpl() CreateImpl() Inherited from SfcInstance
Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink) Discover(ISfcDependencyDiscoveryObjectSink)

Unused for now. Discovery for this should have been taken care of by the parent.

DropImpl() DropImpl() DropImpl() Inherited from SfcInstance
GetChildCollection(String) GetChildCollection(String) GetChildCollection(String)

Get the child collection in this instance for the given element name string.

(Inherited from SfcInstance)
GetDomain() GetDomain() GetDomain() Inherited from SfcInstance
GetObjectFactory() GetObjectFactory() GetObjectFactory()
GetPropertySet() GetPropertySet() GetPropertySet() Inherited from SfcInstance
GetTypeMetadataImpl() GetTypeMetadataImpl() GetTypeMetadataImpl() Inherited from SfcInstance
InitializeUIPropertyState() InitializeUIPropertyState() InitializeUIPropertyState()

Overridable from the child objects who care about initializing their states (dynamic metadata which is currently the ".Enabled" property)

(Inherited from SfcInstance)
MarkForDrop(Boolean) MarkForDrop(Boolean) MarkForDrop(Boolean)
MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) Inherited from SfcInstance
MarkRootAsConnected() MarkRootAsConnected() MarkRootAsConnected() Inherited from SfcInstance
MoveImpl(SfcInstance) MoveImpl(SfcInstance) MoveImpl(SfcInstance) Inherited from SfcInstance
OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) OnPropertyMetadataChanges(SfcPropertyMetadataChangedEventArgs) Inherited from SfcInstance
OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs) OnPropertyValueChanges(PropertyChangedEventArgs) Inherited from SfcInstance
PostAlter(Object) PostAlter(Object) PostAlter(Object) Inherited from SfcInstance
PostCreate(Object) PostCreate(Object) PostCreate(Object) Inherited from SfcInstance
PostDrop(Object) PostDrop(Object) PostDrop(Object) Inherited from SfcInstance
PostMove(Object) PostMove(Object) PostMove(Object) Inherited from SfcInstance
PostRename(Object) PostRename(Object) PostRename(Object) Inherited from SfcInstance
Refresh() Refresh() Refresh()

refreshes the object's properties by reading them from the server

(Inherited from SfcInstance)
Rename(String) Rename(String) Rename(String)
RenameImpl(SfcKey) RenameImpl(SfcKey) RenameImpl(SfcKey) Inherited from SfcInstance
ResetKey() ResetKey() ResetKey() Inherited from SfcInstance
Serialize(XmlWriter) Serialize(XmlWriter) Serialize(XmlWriter) Inherited from SfcInstance
ToString() ToString() ToString() Inherited from SfcInstance
UpdateUIPropertyState() UpdateUIPropertyState() UpdateUIPropertyState() Inherited from SfcInstance
Validate() Validate() Validate()

Basic child object's validation

(Inherited from SfcInstance)

Explicit Interface Implementations

ISfcAlterable.ScriptAlter() ISfcAlterable.ScriptAlter() ISfcAlterable.ScriptAlter()
ISfcRenamable.Rename(SfcKey) ISfcRenamable.Rename(SfcKey) ISfcRenamable.Rename(SfcKey)
ISfcRenamable.ScriptRename(SfcKey) ISfcRenamable.ScriptRename(SfcKey) ISfcRenamable.ScriptRename(SfcKey)

Events

propertyChanged propertyChanged propertyChanged Inherited from SfcInstance
PropertyChanged PropertyChanged PropertyChanged Inherited from SfcInstance
propertyMetadataChanged propertyMetadataChanged propertyMetadataChanged Inherited from SfcInstance
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged Inherited from SfcInstance

Applies to