Interface CampusSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CampusSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CampusList	getCampuses()	Gets the campus list resulting from a search.
CampusQueryInspector	getCampusQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
CampusSearchResultsRecord	getCampusSearchResultsRecord(Type campusSearchRecordType)	Gets the campus search results record corresponding to the given campus 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

getCampuses

CampusList getCampuses()

Gets the campus list resulting from a search.

Returns:

the campus list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCampusQueryInspector

CampusQueryInspector getCampusQueryInspector()

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.

getCampusSearchResultsRecord

CampusSearchResultsRecord getCampusSearchResultsRecord(Type campusSearchRecordType)
                                                throws OperationFailedException

Gets the campus search results record corresponding to the given campus search record Type. This method must be used to retrieve an object implementing the requested record.

Parameters:

campusSearchRecordType - a campus search record type

Returns:

the campus search results record

Throws:

NullArgumentException - campusSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(campusSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.