Interface AssessmentSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AssessmentSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AssessmentQueryInspector	getAssessmentQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AssessmentList	getAssessments()	Gets the assessment list resulting from the search.
AssessmentSearchResultsRecord	getAssessmentSearchResultsRecord(Type assessmentSearchRecordType)	Gets the assessment search order record corresponding to the given assessment 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

getAssessments

AssessmentList getAssessments()

Gets the assessment list resulting from the search.

Returns:

the assessment list

Throws:

IllegalStateException - the assessment list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAssessmentQueryInspector

AssessmentQueryInspector getAssessmentQueryInspector()

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.

getAssessmentSearchResultsRecord

AssessmentSearchResultsRecord getAssessmentSearchResultsRecord(Type assessmentSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

assessmentSearchRecordType - an assessment search record type

Returns:

the assessment search results record

Throws:

NullArgumentException - assessmentSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.