Interface ProjectSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProjectSearch
extends OsidSearch

The search interface for governing project searches.

Method Summary

Modifier and Type	Method	Description
ProjectSearchRecord	getProjectSearchRecord(Type projectSearchRecordType)	Gets the search record corresponding to the given project search record Type.
void	orderProjectResults(ProjectSearchOrder projectSearchOrder)	Specify an ordering to the search results.
void	searchAmongProjects(IdList ProjectIds)	Execute this search among the given list of projects.

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

searchAmongProjects

void searchAmongProjects(IdList ProjectIds)

Execute this search among the given list of projects.

Parameters:

ProjectIds - list of projects

Throws:

NullArgumentException - ProjectIds is null

Compliance:

mandatory - This method must be implemented.

orderProjectResults

void orderProjectResults(ProjectSearchOrder projectSearchOrder)

Specify an ordering to the search results.

Parameters:

projectSearchOrder - project search order

Throws:

NullArgumentException - projectSearchOrder is null

UnsupportedException - projectSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProjectSearchRecord

ProjectSearchRecord getProjectSearchRecord(Type projectSearchRecordType)
                                    throws OperationFailedException

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

Parameters:

projectSearchRecordType - a project search record type

Returns:

the project search record

Throws:

NullArgumentException - projectSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(projectSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.