FilterDescriptor Members

Include Protected Members
Include Inherited Members

Filters are the fundamental way in which the Business Data Catalog captures user (or system) input and plumbs it through to the backend API invocation. FilterDescriptors describe where in a complex series of parameters, a filter value should be inserted. This is accomplished by 'tagging' the TypeDescriptors representing complex parameters of a Method definition to flag where the insertion should happen. It is important to note that the backend must supply the functionality for filtering; the FilterDescriptors merely form a mechanism to surface this to the end user. FilterDescriptor objects are owned (contained) inside Method objects. They are subsequently referred by TypeDescriptor objects.

The FilterDescriptor type exposes the following members.

Properties

	Name	Description
	DefaultDisplayName	Gets the default display name of the metadata object. (Inherited from MetadataObject.)
	Id	Gets the unique ID of the metadata object from the metadata repository. (Inherited from MetadataObject.)
	IsCached	Indicates whether this metadata object is cached or not. (Inherited from MetadataObject.)
	LocalizedDisplayName	Gets or sets the localized display name for the metadata object. (Inherited from MetadataObject.)
	LocalizedDisplayNames	Gets all the localized display names available for this metadata object. (Inherited from MetadataObject.)
	Method	Returns the method to which the FilterDescriptor belongs.
	Name	Gets or sets the name of the metadata object. (Inherited from MetadataObject.)
	Properties	Gets all the properties that belong to this metadata object. (Inherited from MetadataObject.)
	Type	Sets or gets the type of the filter descriptor.

Top

Methods

	Name	Description
	ContainsLocalizedDisplayName	Indicates whether the metadata object contains a localized display name. (Inherited from MetadataObject.)
	Delete	Deletes the filter descriptor from the Business Data Catalog. (Overrides AccessControlledMetadataObject.Delete().)
	DeleteInternal	When overridden in a derived class, deletes the metadata object and all of its children as per the specified SQL command. (Inherited from MetadataObject.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetAccessControlList	A virtual method that is designed to return the list of access control entries (ACEs) associated with the metadata object registered in the Business Data Catalog. (Inherited from AccessControlledMetadataObject.)
	GetById	Gets the filter descriptor object given its ID.
	GetHashCode	(Inherited from Object.)
	GetNearestIndividuallySecurableMetadataObjectAncestor	Returns the nearest individually securable parent metadata object, in this case the Method. (Overrides AccessControlledMetadataObject.GetNearestIndividuallySecurableMetadataObjectAncestor().)
	GetType	(Inherited from Object.)
	IsPrimitive	Indicates whether the metadata object is of the specified primitive type. (Inherited from MetadataObject.)
	MemberwiseClone	(Inherited from Object.)
	MergeXml
	Read	Reads a filter descriptor object from the Business Data Catalog database. overwriting the current value of the fields of the object with whatever was present in the metadata database. For example, if you change the name of a FilterDescriptor and then call .Read on the FilterDescriptor, the name will be reset to whatever is in the database. (Overrides MetadataObject.Read().)
	ReadInternal	When overridden in a derived class, reads the metadata object from the metadata repository and creates an object. (Inherited from MetadataObject.)
	ReadXml
	ToString	(Inherited from Object.)
	Update	Updates the filter descriptor metadata with the changes. (Overrides AccessControlledMetadataObject.Update().)
	UpdateInternal	Infrastructure. (Overrides MetadataObject.UpdateInternal(SqlCommand).)
	WriteXml	(Overrides MetadataObject.WriteXml(XmlWriter, PackageContents).)
	WriteXmlLocalizedNames	Writes the specified XML fragment containing localized names in the metadata repository. (Inherited from MetadataObject.)
	WriteXmlProperties	Writes the specified XML fragment containing properties in the metadata repository. (Inherited from MetadataObject.)
	WriteXmlSecurity	Writes the XML fragment containing security information. (Inherited from AccessControlledMetadataObject.)

Top

Fields

	Name	Description
	version	Represents the version number of the metadata object. (Inherited from MetadataObject.)

Top

See Also

Reference

FilterDescriptor Class

Microsoft.Office.Server.ApplicationRegistry.Administration Namespace