Interface ProgramSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProgramSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProgramQueryInspector	getProgramQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProgramList	getPrograms()	Gets the program list resulting from a search.
ProgramSearchResultsRecord	getProgramSearchResultsRecord(Type programSearchRecordType)	Gets the program search results record corresponding to the given program search record Type .This method is used to retrieve an object implementing the requested record.

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

getPrograms

ProgramList getPrograms()

Gets the program list resulting from a search.

Returns:

the program list

Throws:

IllegalStateException - the program list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getProgramQueryInspector

ProgramQueryInspector getProgramQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getProgramSearchResultsRecord

ProgramSearchResultsRecord getProgramSearchResultsRecord(Type programSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

programSearchRecordType - a program search record type

Returns:

the program search results record

Throws:

NullArgumentException - programSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.