Interface AssessmentPartSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AssessmentPartSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AssessmentPartQueryInspector	getAssessmentPartQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AssessmentPartList	getAssessmentParts()	Gets the AssessmentPartList resulting from a search.
AssessmentPartSearchResultsRecord	getAssessmentPartSearchResultsRecord(Type assessmentPartSearchRecordType)	Gets the assessment part search results record corresponding to the given assessment part search record Type .This method must be 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

getAssessmentParts

AssessmentPartList getAssessmentParts()

Gets the AssessmentPartList resulting from a search.

Returns:

the assessment part list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAssessmentPartQueryInspector

AssessmentPartQueryInspector getAssessmentPartQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the assessment part query inspector

Compliance:

mandatory - This method must be implemented.

getAssessmentPartSearchResultsRecord

AssessmentPartSearchResultsRecord getAssessmentPartSearchResultsRecord(Type assessmentPartSearchRecordType)
                                                                throws OperationFailedException,
PermissionDeniedException

Gets the assessment part search results record corresponding to the given assessment part search record Type .This method must be used to retrieve an object implementing the requested record.

Parameters:

assessmentPartSearchRecordType - an assessment part search record type

Returns:

the assessment part search results record

Throws:

NullArgumentException - assessmentPartSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(assessmentPartSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.