SPDataStore.GetFilter Method

Article
07/24/2014

Retrieves a filter from a SharePoint list.

Namespace: Microsoft.PerformancePoint.Scorecards.Store
Assembly: Microsoft.PerformancePoint.Scorecards.Store (in Microsoft.PerformancePoint.Scorecards.Store.dll)

Syntax

'Declaration
Public Function GetFilter ( _
    location As RepositoryLocation _
) As Filter
'Usage
Dim instance As SPDataStore
Dim location As RepositoryLocation
Dim returnValue As Filter

returnValue = instance.GetFilter(location)

public Filter GetFilter(
    RepositoryLocation location
)

Parameters

location
Type: Microsoft.PerformancePoint.Scorecards.RepositoryLocation

The location of the filter in the SharePoint list. Only the ItemUrl property must be defined.

Return Value

Type: Microsoft.PerformancePoint.Scorecards.Filter
The requested filter, or a null reference (Nothing in Visual Basic) if it does not exist.

Implements

IBIMonitoringStore.GetFilter(RepositoryLocation)

Remarks

PerformancePoint Services in Microsoft SharePoint Server 2010 uses SharePoint lists as the repository for all first class objects except data sources.

Examples

The following code example shows how to retrieve a filter from the repository, based on the server-relative path to the object.

Before you can compile this code example, you must do the following:

Configure your development environment and create a C# class library project in Visual Studio. For information about configuring a development environment, see Setting Up the Development Environment for SharePoint 2010 on Windows Vista, Windows 7, and Windows Server 2008.
Add the Microsoft.PerformancePoint.Scorecards.Client, Microsoft.PerformancePoint.Scorecards.ServerCommon, and Microsoft.PerformancePoint.Scorecards.Store DLLs as references to your project. For more information about PerformancePoint Services in Microsoft SharePoint Server 2010 DLLs, see PerformancePoint Services DLLs Used in Development Scenarios.

Add the following using directives to your class.

using Microsoft.PerformancePoint.Scorecards;
using Microsoft.PerformancePoint.Scorecards.Store;

Create a method that defines a string variable named "relativePath" to store the server-relative path to the object. The following example path sets the object identifier to "5": /BI Center/Lists/PerformancePoint Content/5_.000.
Paste the following code example into the new method.

// Retrieve the object from the specified location.
// The RepositoryLocation constructor takes the server-relative path to the object.
Filter requestedFilter = SPDataStore.GlobalDataStore.GetFilter(new RepositoryLocation(relativePath));