OSID Logo
OSID Specifications
assessment authoring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.authoring.AssessmentPartSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidContainableSearchOrder
osid.OsidOperableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByAssessment
Description

Specifies a preference for ordering the result set by the assessment.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsAssessmentSearchOrder
Description

Tests if an assessment search order is available.

Returnboolean true if an assessment search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentSearchOrder
Description

Gets the assessment order.

Returnosid.assessment.AssessmentSearchOrderthe assessment search order
ErrorsUNIMPLEMENTED supportsAssessmentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAssessmentSearchOrder() is true.
MethodorderBySection
Description

Specifies a preference for ordering the result set by the section.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByWeight
Description

Specifies a preference for ordering the result set by the weight.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByAllocatedTime
Description

Specifies a preference for ordering the result set by the allocated time.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentPartSearchOrderRecord
Description

Gets the assessment part search order record corresponding to the given assessment part record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeassessmentPartRecordTypean assessment part record type
Returnosid.assessment.authoring.records.AssessmentPartSearchOrderRecordthe assessment part search order record
ErrorsNULL_ARGUMENT assessmentPartRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(assessmentPartRecordType) is false
CompliancemandatoryThis method must be implemented.