OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AwardEntryQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching award entries. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchStudentId
Description

Sets the student Id for this query.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearStudentIdTerms
Description

Clears the student Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsStudentQuery
Description

Tests if a StudentQuery is available.

Returnboolean true if a student query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetStudentQuery
Description

Gets the query for a student option. Multiple retrievals produce a nested OR term.

Returnosid.resource.ResourceQuerya student query
ErrorsUNIMPLEMENTED supportsStudentQuery() is false
ComplianceoptionalThis method must be implemented if supportsStudentQuery() is true.
MethodclearStudentTerms
Description

Clears the student option terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAwardId
Description

Sets the award Id for this query to match entries that have an entry for the given course.

Parametersosid.id.IdawardIdan award Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT awardId is null
CompliancemandatoryThis method must be implemented.
MethodclearAwardIdTerms
Description

Clears the award Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAwardQuery
Description

Tests if an AwardQuery is available.

Returnboolean true if an award query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAwardQuery
Description

Gets the query for an award entry. Multiple retrievals produce a nested OR term.

Returnosid.recognition.AwardQueryan award query
ErrorsUNIMPLEMENTED supportsAwardQuery() is false
ComplianceoptionalThis method must be implemented if supportsAwardQuery() is true.
MethodclearAwardTerms
Description

Clears the award terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDateAwarded
Description

Matches award dates between the given dates inclusive.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyDateAwarded
Description

Matches entries that have any award date.

Parametersbooleanmatch true to match entries with any award date, false to match entries with no award date
CompliancemandatoryThis method must be implemented.
MethodclearDateAwardedTerms
Description

Clears the award date terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProgramId
Description

Sets the program Id for this query.

Parametersosid.id.IdprogramIda program Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT programId is null
CompliancemandatoryThis method must be implemented.
MethodclearProgramIdTerms
Description

Clears the program Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProgramQuery
Description

Tests if a ProgramQuery is available.

Returnboolean true if a program query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProgramQuery
Description

Gets the query for a program. Multiple retrievals produce a nested OR term.

Returnosid.course.program.ProgramQuerya program query
ErrorsUNIMPLEMENTED supportsProgramQuery() is false
ComplianceoptionalThis method must be implemented if supportsProgramQuery() is true.
MethodmatchAnyProgram
Description

Matches entries that have any program.

Parametersbooleanmatch true to match entries with any program false to match entries with no program
CompliancemandatoryThis method must be implemented.
MethodclearProgramTerms
Description

Clears the program terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseId
Description

Sets the course Id for this query to match entries that have an entry for the given course.

Parametersosid.id.IdcourseIda course Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseIdTerms
Description

Clears the course Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseQuery
Description

Tests if a CourseQuery is available.

Returnboolean true if a course query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseQuery
Description

Gets the query for a course entry. Multiple retrievals produce a nested OR term.

Returnosid.course.CourseQuerya course query
ErrorsUNIMPLEMENTED supportsCourseQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseQuery() is true.
MethodmatchAnyCourse
Description

Matches entries that have any course.

Parametersbooleanmatch true to match entries with any course, false to match entries with no course
CompliancemandatoryThis method must be implemented.
MethodclearCourseTerms
Description

Clears the course terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAssessmentId
Description

Sets the assessment Id for this query to match entries that have an entry for the given assessment,

Parametersosid.id.IdassessmentIdan assessment Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT assessmentId is null
CompliancemandatoryThis method must be implemented.
MethodclearAssessmentIdTerms
Description

Clears the assessment Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAssessmentQuery
Description

Tests if an AssessmentQuery is available.

Returnboolean true if an assessment query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentQuery
Description

Gets the query for an assessment entry. Multiple retrievals produce a nested OR term.

Returnosid.assessment.AssessmentQueryan assessment query
ErrorsUNIMPLEMENTED supportsAssessmentQuery() is false
ComplianceoptionalThis method must be implemented if supportsAssessmentQuery() is true.
MethodmatchAnyAssessment
Description

Matches entries that have any assessment.

Parametersbooleanmatch true to match entries with any assessment, false to match entries with no assessment
CompliancemandatoryThis method must be implemented.
MethodclearAssessmentTerms
Description

Clears the assessment terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCourseCatalogId
Description

Sets the course catalog Id for this query to match entries assigned to course catalogs.

Parametersosid.id.IdcourseCatalogIdthe course catalog Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT courseCatalogId is null
CompliancemandatoryThis method must be implemented.
MethodclearCourseCatalogIdTerms
Description

Clears the course catalog Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCourseCatalogQuery
Description

Tests if a CourseCatalogQuery is available.

Returnboolean true if a course catalog query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogQuery
Description

Gets the query for a course catalog. Multiple retrievals produce a nested OR term.

Returnosid.course.CourseCatalogQuerythe course catalog query
ErrorsUNIMPLEMENTED supportsCourseCatalogQuery() is false
ComplianceoptionalThis method must be implemented if supportsCourseCatalogQuery() is true.
MethodclearCourseCatalogTerms
Description

Clears the course catalog terms.

CompliancemandatoryThis method must be implemented.
MethodgetAwardEntryQueryRecord
Description

Gets the award entry query record corresponding to the given AwardEntry record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeawardEntryRecordTypean award entry record type
Returnosid.course.chronicle.records.AwardEntryQueryRecordthe award entry query record
ErrorsNULL_ARGUMENT awardEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(awardEntryRecordType) is false
CompliancemandatoryThis method must be implemented.