Using the KeywordQuery Class to Get a List of Departments

Company | Articles & Research | Services | Software |

Our Company

All SharePoint Articles

Security

Development

Accounting / Dynamics

AIS / Dynamics GP

Other

Consulting Services

Freeware / Experiments

Applications	WebParts	Security Components
SharePoint Field Diff And Copy Utility * Written In January, 2012 SharePoint Security Scanner * Written In January, 2012 SharePoint Kerberos Buddy * Written In Feburary, 2011 BioPoint: SharePoint Biometric Authentication * Written In September, 2007 SharePoint List Security Migrator * Written In August, 2007 SharePoint Anti-Keylogger™ * Written In April, 2006 S.M.A.R.T SharePoint™ * Written In May, 2006 SharePoint Sentinel™ * Written In June, 2006 SharePoint Scrubber™ * Written In July, 2006 SharePoint Safeguard™ * Written In August, 2006	SecureSilverlight For SharePoint * Written In January, 2010 Simple Rollup WebPart For SharePoint * Written In Novemember, 2009 SimpleChart For SharePoint * Written In December, 2009 SimpleSecurity For SharePoint * Written In June, 2009 CrytoCollaboration (Encryption) * Written In June, 2007 Sample AJAX Rotator WebPart * Written In July, 2007 Sample SharePoint Redirector WebPart * Written In August, 2006 WFE Server Name WebPart * Written In January, 2006	PDF IRM Protector * Written In December, 2010 ADAM Role Provider * Written In February, 2007 Universal Provider Framework * Written In April, 2007

Contact

Using the KeywordQuery Class to Get a List of Departments

On a recent side project of mine I was writing some SharePoint UserProfile heavy code in order to offer different schemes of showing user data. One of the common methods that I was using was collection building of arbitrary pieces of related user and business structure data, such as building lists of relevant departments assimilated by different data display. While there exist several mechanisms in order to support such a generic call, I have found the Microsoft.Office.Server.Search.Query.KeywordQuery class to be most effective and from a programmatic standpoint exceptionally easy to use (and it’s not just because I think the EnableUrlSmashing property has a nifty name). At a very high level, the KeywordQuery class simply provides the mechanisms in order to execute keyword syntax queries in the same manner as MOSS, returning a DataTable object.

The SDK IMHO adequately covers the innards of the particular classes, so let’s just get down to the code :)

PLAIN TEXT

C#:

public static DataTable RetrieveDepartmentNames(string url, int rowLimit, string department)
{
using (var table = new DataTable())
{
using (var site = new SPSite(url))
{
using (var query = new KeywordQuery(site))
{
query.ResultTypes = ResultType.RelevantResults;
query.EnableStemming = true;
query.TrimDuplicates = true;
query.StartRow = 0;
query.RowLimit = rowLimit;
query.QueryText = string.Format("scope:\"{0}\"", "people");
query.SortList.Add("Rank", SortDirection.Ascending);
query.SelectProperties.Add("Department");
using (ResultTable reader = query.Execute()[ResultType.RelevantResults])
{
table.Load(reader, LoadOption.OverwriteChanges);
}
if (((table.Rows != null)) && (table.Rows.Count> 0))
{
using (var view = new DataView(table) {Sort = department, RowFilter = (string.Format("NOT Isnull({0},'') = '' AND NOT {0} = ''", department))})
{
return view.ToTable("Department", true, new[] { department });
}
}
}
}
}
return null;
}

Important to note is that DataTable objects implement IDisposable since it inherits from MarshalByRefComponent, and even while most consider it unnecessary it is proper to place the references in using statements!

Article Or Research Filed Under SharePoint| SharePoint Development.

2 Comments »

[...] Along the same lines as this post, once one has located the relevant department that they desire from a collection, how is it possible to use that department string name in order to get a list of the relevant employees? As we used the KeywordQuery class the last time, we are going to take the same approach in order to return a new DataTable with those values. [...]

Pingback by SharePoint Shelter » Blog Archive » — November 7, 2008 @ 11:20 am
[...] Using the KeywordQuery Class to Get a List of Departments [...]

Pingback by Links (11/9/2008 « Steve Pietrek - Everything SharePoint) — November 9, 2008 @ 4:53 pm

RSS feed for comments on this post. TrackBack URL

Articles & Research

Latests SharePoint Development Posts

Latests SharePoint Security Posts

Using the KeywordQuery Class to Get a List of Departments

2 Comments »

Leave a comment