Interface AssessmentTakenSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AssessmentTakenSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AssessmentTakenList	getAssessmentsTaken()	Gets the assessment taken list resulting from the search.
AssessmentTakenQueryInspector	getAssessmentTakenQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AssessmentTakenSearchResultsRecord	getAssessmentTakenSearchResultsRecord(Type assessmentTakenSearchRecordType)	Gets the assessment taken record corresponding to the given assessment taken 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

getAssessmentsTaken

AssessmentTakenList getAssessmentsTaken()

Gets the assessment taken list resulting from the search.

Returns:

the assessment taken list

Throws:

IllegalStateException - the assessment taken list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAssessmentTakenQueryInspector

AssessmentTakenQueryInspector getAssessmentTakenQueryInspector()

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.

getAssessmentTakenSearchResultsRecord

AssessmentTakenSearchResultsRecord getAssessmentTakenSearchResultsRecord(Type assessmentTakenSearchRecordType)
                                                                  throws OperationFailedException

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

Parameters:

assessmentTakenSearchRecordType - an assessment taken search record type

Returns:

the assessment taken search results record

Throws:

NullArgumentException - assessmentTakenSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentTakenSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.