Interface AssessmentEntrySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AssessmentEntrySearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AssessmentEntryList	getAssessmentEntries()	Gets the course list resulting from a search.
AssessmentEntryQueryInspector	getAssessmentEntryQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AssessmentEntrySearchResultsRecord	getAssessmentEntrySearchResultsRecord(Type assessmentEntrySearchRecordType)	Gets the assessment entry search results record corresponding to the given assessment entry 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

getAssessmentEntries

AssessmentEntryList getAssessmentEntries()

Gets the course list resulting from a search.

Returns:

the assessment entry list

Throws:

IllegalStateException - the assessment entry list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAssessmentEntryQueryInspector

AssessmentEntryQueryInspector getAssessmentEntryQueryInspector()

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.

getAssessmentEntrySearchResultsRecord

AssessmentEntrySearchResultsRecord getAssessmentEntrySearchResultsRecord(Type assessmentEntrySearchRecordType)
                                                                  throws OperationFailedException

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

Parameters:

assessmentEntrySearchRecordType - an assessment entry search record type

Returns:

the assessment entry search results record

Throws:

NullArgumentException - assessmentEntrySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentEntrySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.