Interface ProjectSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProjectSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
ProjectQueryInspector	getProjectQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
ProjectList	getProjects()	Gets the project list resulting from a search.
ProjectSearchResultsRecord	getProjectSearchResultsRecord(Type projectSearchRecordType)	Gets the project search results record corresponding to the given project search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getProjects

ProjectList getProjects()

Gets the project list resulting from a search.

Returns:

the project list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getProjectQueryInspector

ProjectQueryInspector getProjectQueryInspector()

Gets the inspector for the query to examine the terns used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getProjectSearchResultsRecord

ProjectSearchResultsRecord getProjectSearchResultsRecord(Type projectSearchRecordType)
                                                  throws OperationFailedException

Gets the project search results 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 results record

Throws:

NullArgumentException - projectSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(projectSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.