Interface DirectorySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DirectorySearch
extends OsidSearch

The search interface for gioverning directory searches.

An example to find directories whose name is "Library" sorted by the path name.

DirectoryQuery query = session.getDirectoryQuery();
query.addNameMatch("Library", wordStringMatchType, true);

DirectorySearch search = session.getDirectorySearch();
search.orderByPath();

DirectorySearchResults results = session.getDirectoriesBySearch(query, search);
DirectoryList directories = results.getDirectories();
  

Method Summary

Modifier and Type	Method	Description
DirectorySearchRecord	getDirectorySearchRecord(Type directorySearchRecordType)	Gets the directory search record corresponding to the given directory search record Type.
void	orderDirectoryResults(DirectorySearchOrder directorySearchOrder)	Specify an ordering to the search results.
void	searchAmongDirectories(IdList directoryIds)	Execute this search among the given list of diectories.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongDirectories

void searchAmongDirectories(IdList directoryIds)

Execute this search among the given list of diectories.

Parameters:

directoryIds - list of directory Ids

Throws:

NullArgumentException - directoryIds is null

Compliance:

mandatory - This method must be implemented.

orderDirectoryResults

void orderDirectoryResults(DirectorySearchOrder directorySearchOrder)

Specify an ordering to the search results.

Parameters:

directorySearchOrder - directory search order

Throws:

NullArgumentException - directorySearchOrder is null

UnsupportedException - directorySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDirectorySearchRecord

DirectorySearchRecord getDirectorySearchRecord(Type directorySearchRecordType)
                                        throws OperationFailedException

Gets the directory search record corresponding to the given directory search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

directorySearchRecordType - a directory search record type

Returns:

the directory search record

Throws:

NullArgumentException - directorySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(directorySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.