Interface ProgramOfferingSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProgramOfferingSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProgramOfferingQueryInspector	getProgramOfferingQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProgramOfferingList	getProgramOfferings()	Gets the program offering list resulting from a search.
ProgramOfferingSearchResultsRecord	getProgramOfferingSearchResultsRecord(Type programOfferingSearchRecordType)	Gets the program offering search results record corresponding to the given program offering 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

getProgramOfferings

ProgramOfferingList getProgramOfferings()

Gets the program offering list resulting from a search.

Returns:

the program offering list

Throws:

IllegalStateException - the program offering list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getProgramOfferingQueryInspector

ProgramOfferingQueryInspector getProgramOfferingQueryInspector()

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.

getProgramOfferingSearchResultsRecord

ProgramOfferingSearchResultsRecord getProgramOfferingSearchResultsRecord(Type programOfferingSearchRecordType)
                                                                  throws OperationFailedException

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

Parameters:

programOfferingSearchRecordType - a program offering search record type

Returns:

the program offering search results record

Throws:

NullArgumentException - programOfferingSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programOfferingSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.