OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.AssessmentTakenSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByAssessmentOffered
Description

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

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

Tests if an assessment search order is available.

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

Gets an assessment offered search order.

Returnosid.assessment.AssessmentOfferedSearchOrderan assessment offered search order
ErrorsUNIMPLEMENTED supportsAssessmentOfferedSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsAssessmentOfferedSearchOrder() is true.
MethodorderByTaker
Description

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

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

Tests if a resource search order is available.

Returnboolean true if a resource search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTakerSearchOrder
Description

Gets a resource search order.

Returnosid.resource.ResourceSearchOrdera resource search order
ErrorsUNIMPLEMENTED supportsTakerSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsTakerSearchOrder() is true.
MethodorderByTakingAgent
Description

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

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

Tests if an agent search order is available.

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

Gets an agent search order.

Returnosid.authentication.AgentSearchOrderan agent search order
ErrorsUNIMPLEMENTED supportsTakingAgentSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsTakingAgentSearchOrder() is true.
MethodorderByActualStartTime
Description

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

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

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

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

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

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

Specifies a preference for ordering the result set by the grade system.

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

Tests if a grade system search order is available.

Returnboolean true if a grade system search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetScoreSystemSearchOrder
Description

Gets a grade system search order.

Returnosid.grading.GradeSystemSearchOrdera grade system search order
ErrorsUNIMPLEMENTED supportsScoreSystemSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsScoreSystemSearchOrder() is true.
MethodorderByScore
Description

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

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

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

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

Tests if a grade search order is available.

Returnboolean true if a grade search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradeSearchOrder
Description

Gets a grade search order.

Returnosid.grading.GradeSearchOrdera grade search order
ErrorsUNIMPLEMENTED supportsGradeSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsGradeSearchOrder() is true.
MethodorderByFeedback
Description

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

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

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

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

Tests if an assessment taken search order is available.

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

Gets an assessment taken search order.

Returnosid.assessment.AssessmentTakenSearchOrdera rubric assessment taken search order
ErrorsUNIMPLEMENTED supportsRubricSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsRubricSearchOrder() is true.
MethodgetAssessmentTakenSearchOrderRecord
Description

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

Parametersosid.type.TypeassessmentTakenRecordTypean assessment record type
Returnosid.assessment.records.AssessmentTakenSearchOrderRecordthe assessment taken search order record
ErrorsNULL_ARGUMENT assessmentTakenRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(assessmentTakenRecordType) is false
CompliancemandatoryThis method must be implemented.