Interface ProgramEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProgramEntrySearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProgramEntryList	getProgramEntries()	Gets the course list resulting from a search.
ProgramEntryQueryInspector	getProgramEntryQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProgramEntrySearchResultsRecord	getProgramEntrySearchResultsRecord(Type programEntrySearchRecordType)	Gets the program entry search results record corresponding to the given program entry 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

getProgramEntries

ProgramEntryList getProgramEntries()

Gets the course list resulting from a search.

Returns:

the program entry list

Throws:

IllegalStateException - the program entry list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getProgramEntryQueryInspector

ProgramEntryQueryInspector getProgramEntryQueryInspector()

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.

getProgramEntrySearchResultsRecord

ProgramEntrySearchResultsRecord getProgramEntrySearchResultsRecord(Type programEntrySearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

programEntrySearchRecordType - a program entry search record type

Returns:

the program entry search results record

Throws:

NullArgumentException - programEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.