Interface AssessmentOfferedSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AssessmentOfferedSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AssessmentOfferedQueryInspector	getAssessmentOfferedQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AssessmentOfferedSearchResultsRecord	getAssessmentOfferedSearchResultsRecord(Type assessmentOfferedSearchRecordType)	Gets the assessment offered search results record corresponding to the given assessment offered search record Type.
AssessmentOfferedList	getAssessmentsOffered()	Gets the assessment offered list resulting from the search.

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

getAssessmentsOffered

AssessmentOfferedList getAssessmentsOffered()

Gets the assessment offered list resulting from the search.

Returns:

the assessment offered list

Throws:

IllegalStateException - the assessment offered list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAssessmentOfferedQueryInspector

AssessmentOfferedQueryInspector getAssessmentOfferedQueryInspector()

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.

getAssessmentOfferedSearchResultsRecord

AssessmentOfferedSearchResultsRecord getAssessmentOfferedSearchResultsRecord(Type assessmentOfferedSearchRecordType)
                                                                      throws OperationFailedException

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

Parameters:

assessmentOfferedSearchRecordType - an assessment offered search record type

Returns:

the assessment offered search results record

Throws:

NullArgumentException - assessmentOfferedSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentOfferedSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.