OSID Logo
OSID Specifications
course chronicle package
Version 3.1.0
Interfaceosid.course.chronicle.ProgramEntryQuery
Implementsosid.OsidRelationshipQuery
Used Byosid.course.chronicle.ProgramEntryQuery
osid.course.chronicle.ProgramEntryQuerySession
osid.course.chronicle.ProgramEntrySearchSession
osid.course.chronicle.ProgramEntrySmartCourseCatalogSession
Description

This is the query for searching program 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.IdresourceId a resource Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
Compliancemandatory This method must be implemented.
MethodclearStudentIdTerms
Description

Clears the student Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsStudentQuery
Description

Tests if a StudentQuery is available.

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

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

Returnosid.resource.ResourceQuery a student query
ErrorsUNIMPLEMENTED supportsStudentQuery() is false
Complianceoptional This method must be implemented if supportsStudentQuery() is true.
MethodclearStudentTerms
Description

Clears the student option terms.

Compliancemandatory This method must be implemented.
MethodmatchProgramId
Description

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

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

Clears the program Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsProgramQuery
Description

Tests if a ProgramQuery is available.

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

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

Returnosid.course.program.ProgramQuery a program query
ErrorsUNIMPLEMENTED supportsProgramQuery() is false
Complianceoptional This method must be implemented if supportsProgramQuery() is true.
MethodclearProgramTerms
Description

Clears the program terms.

Compliancemandatory This method must be implemented.
MethodmatchParentProgramEntryId
Description

Sets the parent program entry Id for this query.

Parametersosid.id.IdprogramEntryId a program entry Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT programEntryId is null
Compliancemandatory This method must be implemented.
MethodclearParentProgramEntryIdTerms
Description

Clears the parent program entry Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsParentProgramEntryQuery
Description

Tests if a ProgramEntryQuery is available.

Returnboolean true if a program entry query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetParentProgramEntryQuery
Description

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

Returnosid.course.chronicle.ProgramEntryQuery a parent program entry query
ErrorsUNIMPLEMENTED supportsParentProgramEntryQuery() is false
Complianceoptional This method must be implemented if supportsParentProgramEntryQuery() is true.
MethodmatchAnyParentProgramEntry
Description

Matches program entries that have any parent.

Parametersbooleanmatch true to match entries with a parent, false to match entries with no parent
Compliancemandatory This method must be implemented.
MethodclearParentProgramEntryTerms
Description

Clears the parent program entry terms.

Compliancemandatory This method must be implemented.
MethodmatchIsMatriculationKnown
Description

Matches credential entries with a matriculation known value.

Parametersbooleanmatch true to match a true value, false to match a false value
Compliancemandatory This method must be implemented.
MethodclearIsMatriculationKnownTerms
Description

Clears the matriculation known terms.

Compliancemandatory This method must be implemented.
MethodmatchEntranceDate
Description

Matches entrance dates between the given dates inclusive.

Parametersosid.calendaring.DateTimefrom starting date
osid.calendaring.DateTimeto ending 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
Compliancemandatory This method must be implemented.
MethodmatchAnyEntranceDate
Description

Matches program entries with any entrance date.

Parametersbooleanmatch true to match entries with a entrance date, false to match entries with no entrance date
Compliancemandatory This method must be implemented.
MethodclearEntranceDateTerms
Description

Clears the entrance date terms.

Compliancemandatory This method must be implemented.
MethodmatchEntranceTermId
Description

Sets the entrance term Id for this query.

Parametersosid.id.IdentranceTermId a entrance term Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT entranceTermId is null
Compliancemandatory This method must be implemented.
MethodclearEntranceTermIdTerms
Description

Clears the entrance term Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsEntranceTermQuery
Description

Tests if a TermQuery is available.

Returnboolean true if a entrance term query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetEntranceTermQuery
Description

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

Returnosid.course.TermQuery a entrance term query
ErrorsUNIMPLEMENTED supportsEntranceTermQuery() is false
Complianceoptional This method must be implemented if supportsEntranceTermQuery() is true.
MethodclearEntranceTermTerms
Description

Clears the entrance term terms.

Compliancemandatory This method must be implemented.
MethodmatchIsExpectedToComplete
Description

Matches credential entries with a expected to complete value.

Parametersbooleanmatch true to match a true value, false to match a false value
Compliancemandatory This method must be implemented.
MethodclearIsExpectedToCompleteTerms
Description

Clears the expected to complete terms.

Compliancemandatory This method must be implemented.
MethodmatchExpectedCompletionDate
Description

Matches expected completion dates between the given dates inclusive.

Parametersosid.calendaring.DateTimefrom starting date
osid.calendaring.DateTimeto ending 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
Compliancemandatory This method must be implemented.
MethodmatchAnyExpectedCompletionDate
Description

Matches program entries with any expected completion date.

Parametersbooleanmatch true to match entries with a expected completion date, false to match entries with no expected completion date
Compliancemandatory This method must be implemented.
MethodclearExpectedCompletionDateTerms
Description

Clears the expected completion date terms.

Compliancemandatory This method must be implemented.
MethodmatchExpectedCompletionTermId
Description

Sets the expected completion term Id for this query.

Parametersosid.id.IdexpectedCompletionTermId a expected completion term Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT expectedCompletionTermId is null
Compliancemandatory This method must be implemented.
MethodclearExpectedCompletionTermIdTerms
Description

Clears the expected completion term Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsExpectedCompletionTermQuery
Description

Tests if a TermQuery is available.

Returnboolean true if a expected completion term query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetExpectedCompletionTermQuery
Description

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

Returnosid.course.TermQuery a expected completion term query
ErrorsUNIMPLEMENTED supportsExpectedCompletionTermQuery() is false
Complianceoptional This method must be implemented if supportsExpectedCompletionTermQuery() is true.
MethodclearExpectedCompletionTermTerms
Description

Clears the expected completion term terms.

Compliancemandatory This method must be implemented.
MethodmatchIsEnrolled
Description

Matches credential entries with a enrolled value.

Parametersbooleanmatch true to match a true value, false to match a false value
Compliancemandatory This method must be implemented.
MethodclearIsEnrolledTerms
Description

Clears the enrolled terms.

Compliancemandatory This method must be implemented.
MethodmatchIsActivelyEnrolled
Description

Matches credential entries with a actively enrolled value.

Parametersbooleanmatch true to match a true value, false to match a false value
Compliancemandatory This method must be implemented.
MethodclearIsActivelyEnrolledTerms
Description

Clears the actively enrolled terms.

Compliancemandatory This method must be implemented.
MethodmatchIsOnLeave
Description

Matches credential entries with a on leave value.

Parametersbooleanmatch true to match a true value, false to match a false value
Compliancemandatory This method must be implemented.
MethodclearIsOnLeaveTerms
Description

Clears the on leave terms.

Compliancemandatory This method must be implemented.
MethodmatchHasWithdrawn
Description

Matches credential entries with a withdrawn value.

Parametersbooleanmatch true to match a true value, false to match a false value
Compliancemandatory This method must be implemented.
MethodclearHasWithdrawnTerms
Description

Clears the withdrawn terms.

Compliancemandatory This method must be implemented.
MethodmatchWithdrawDate
Description

Matches withdraw dates between the given dates inclusive.

Parametersosid.calendaring.DateTimefrom starting date
osid.calendaring.DateTimeto ending 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
Compliancemandatory This method must be implemented.
MethodmatchAnyWithdrawDate
Description

Matches program entries with any withdraw date.

Parametersbooleanmatch true to match entries with a withdraw date, false to match entries with no withdraw date
Compliancemandatory This method must be implemented.
MethodclearWithdrawDateTerms
Description

Clears the withdraw date terms.

Compliancemandatory This method must be implemented.
MethodmatchWithdrawTermId
Description

Sets the withdraw term Id for this query.

Parametersosid.id.IdwithdrawTermId a withdraw term Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT withdrawTermId is null
Compliancemandatory This method must be implemented.
MethodclearWithdrawTermIdTerms
Description

Clears the withdraw term Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsWithdrawTermQuery
Description

Tests if a TermQuery is available.

Returnboolean true if a withdraw term query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetWithdrawTermQuery
Description

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

Returnosid.course.TermQuery a withdraw term query
ErrorsUNIMPLEMENTED supportsWithdrawTermQuery() is false
Complianceoptional This method must be implemented if supportsWithdrawTermQuery() is true.
MethodclearWithdrawTermTerms
Description

Clears the withdraw term terms.

Compliancemandatory This method must be implemented.
MethodmatchComplete
Description

Matches completed programs.

Parametersbooleanmatch true if a positive match, false for a negative match
Compliancemandatory This method must be implemented.
MethodclearCompleteTerms
Description

Clears the complete terms.

Compliancemandatory This method must be implemented.
MethodmatchCompletionDate
Description

Matches completion dates between the given dates inclusive.

Parametersosid.calendaring.DateTimefrom starting date
osid.calendaring.DateTimeto ending 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
Compliancemandatory This method must be implemented.
MethodmatchAnyCompletionDate
Description

Matches program entries with any completion date.

Parametersbooleanmatch true to match entries with a completion date, false to match entries with no completion date
Compliancemandatory This method must be implemented.
MethodclearCompletionDateTerms
Description

Clears the completion date terms.

Compliancemandatory This method must be implemented.
MethodmatchCompletionTermId
Description

Sets the completion term Id for this query.

Parametersosid.id.IdcompletionTermId a completion term Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT completionTermId is null
Compliancemandatory This method must be implemented.
MethodclearCompletionTermIdTerms
Description

Clears the completion term Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsCompletionTermQuery
Description

Tests if a TermQuery is available.

Returnboolean true if a completion term query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetCompletionTermQuery
Description

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

Returnosid.course.TermQuery a completion term query
ErrorsUNIMPLEMENTED supportsCompletionTermQuery() is false
Complianceoptional This method must be implemented if supportsCompletionTermQuery() is true.
MethodclearCompletionTermTerms
Description

Clears the completion term terms.

Compliancemandatory This method must be implemented.
MethodmatchLevelId
Description

Sets the level Id for this query.

Parametersosid.id.IdlevelId a level Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT levelId is null
Compliancemandatory This method must be implemented.
MethodclearLevelIdTerms
Description

Clears the level Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsLevelQuery
Description

Tests if a GradeQuery is available.

Returnboolean true if a level query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetLevelQuery
Description

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

Returnosid.grading.GradeQuery a level query
ErrorsUNIMPLEMENTED supportsLevelQuery() is false
Complianceoptional This method must be implemented if supportsLevelQuery() is true.
MethodmatchAnyLevel
Description

Matches program entries with any level.

Parametersbooleanmatch true to match entries with a level, false to match entries with no level
Compliancemandatory This method must be implemented.
MethodclearLevelTerms
Description

Clears the level terms.

Compliancemandatory This method must be implemented.
MethodmatchStandingId
Description

Sets the standing Id for this query.

Parametersosid.id.IdstandingId a standing Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT standingId is null
Compliancemandatory This method must be implemented.
MethodclearStandingIdTerms
Description

Clears the standing Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsStandingQuery
Description

Tests if a GradeQuery is available.

Returnboolean true if a standing query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetStandingQuery
Description

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

Returnosid.grading.GradeQuery a standing query
ErrorsUNIMPLEMENTED supportsStandingQuery() is false
Complianceoptional This method must be implemented if supportsStandingQuery() is true.
MethodmatchAnyStanding
Description

Matches program entries with any standing.

Parametersbooleanmatch true to match entries with a standing, false to match entries with no standing
Compliancemandatory This method must be implemented.
MethodclearStandingTerms
Description

Clears the standing terms.

Compliancemandatory This method must be implemented.
MethodmatchAdmissionDate
Description

Matches admission dates between the given dates inclusive.

Parametersosid.calendaring.DateTimefrom starting date
osid.calendaring.DateTimeto ending 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
Compliancemandatory This method must be implemented.
MethodmatchAnyAdmissionDate
Description

Matches entries that have any admission date.

Parametersbooleanmatch true to match entries with any admission date, false to match entries with no admission date
Compliancemandatory This method must be implemented.
MethodclearAdmissionDateTerms
Description

Clears the admission date terms.

Compliancemandatory This method must be implemented.
MethodmatchTermId
Description

Sets the term Id for this query.

Parametersosid.id.IdtermId a term Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT termId is null
Compliancemandatory This method must be implemented.
MethodclearTermIdTerms
Description

Clears the term Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsTermQuery
Description

Tests if a TermQuery is available.

Returnboolean true if a term query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetTermQuery
Description

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

Returnosid.course.TermQuery a term query
ErrorsUNIMPLEMENTED supportsTermQuery() is false
Complianceoptional This method must be implemented if supportsTermQuery() is true.
MethodmatchAnyTerm
Description

Matches entries that have any term.

Parametersbooleanmatch true to match entries specific to a term, false to match entries for the entire enrollment
Compliancemandatory This method must be implemented.
MethodclearTermTerms
Description

Clears the term terms.

Compliancemandatory This method must be implemented.
MethodmatchCreditScaleId
Description

Matches a credit scale Id.

Parametersosid.id.IdgradeSystemId a grade system Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeSystemId is null
Compliancemandatory This method must be implemented.
MethodclearCreditScaleIdTerms
Description

Clears the grade system Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsCreditScaleQuery
Description

Tests if a GradeSystemQuery is available.

Returnboolean true if a grade system query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetCreditScaleQuery
Description

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

Returnosid.grading.GradeSystemQuery a grade system query
ErrorsUNIMPLEMENTED supportsCreditScaleQuery() is false
Complianceoptional This method must be implemented if supportsCreditScaleQuery() is true.
MethodmatchAnyCreditScale
Description

Matches entries that have any credit scale.

Parametersbooleanmatch true to match entries with any credit scale, false to match entries with no credit scale
Compliancemandatory This method must be implemented.
MethodclearCreditScaleTerms
Description

Clears the credit scale terms.

Compliancemandatory This method must be implemented.
MethodmatchCreditsEarned
Description

Matches earned credits between the given range inclusive.

Parametersdecimalfrom starting value
decimalto ending value
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
Compliancemandatory This method must be implemented.
MethodmatchAnyCreditsEarned
Description

Matches entries that have any earned credits.

Parametersbooleanmatch true to match entries with any earned credits, false to match entries with no earned credits
Compliancemandatory This method must be implemented.
MethodclearCreditsEarnedTerms
Description

Clears the earned credits terms.

Compliancemandatory This method must be implemented.
MethodmatchGPAScaleId
Description

Matches a GPA scale Id.

Parametersosid.id.IdgradeSystemId a grade system Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradeSystemId is null
Compliancemandatory This method must be implemented.
MethodclearGPAScaleIdTerms
Description

Clears the grade system Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsGPAScaleQuery
Description

Tests if a GradeSystemQuery is available.

Returnboolean true if a grade system query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetGPAScaleQuery
Description

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

Returnosid.grading.GradeSystemQuery a grade system query
ErrorsUNIMPLEMENTED supportsGPAScaleQuery() is false
Complianceoptional This method must be implemented if supportsGPAScaleQuery() is true.
MethodmatchAnyGPAScale
Description

Matches entries that have any GPA scale.

Parametersbooleanmatch true to match entries with any GPA scale, false to match entries with no GPA scale
Compliancemandatory This method must be implemented.
MethodclearGPAScaleTerms
Description

Clears the credit scale terms.

Compliancemandatory This method must be implemented.
MethodmatchGPA
Description

Matches GPA between the given range inclusive.

Parametersdecimalfrom starting value
decimalto ending value
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
Compliancemandatory This method must be implemented.
MethodmatchAnyGPA
Description

Matches entries that have any GPA.

Parametersbooleanmatch true to match entries with any GPA, false to match entries with no GPA
Compliancemandatory This method must be implemented.
MethodclearGPATerms
Description

Clears the GPA terms.

Compliancemandatory This method must be implemented.
MethodmatchEnrollmentId
Description

Sets the enrollment Id for this query.

Parametersosid.id.IdenrollmentId an enrollment Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT enrollmentId is null
Compliancemandatory This method must be implemented.
MethodclearEnrollmentIdTerms
Description

Clears the enrollment Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsEnrollmentQuery
Description

Tests if an EnrollmentQuery is available.

Returnboolean true if an enrollment query is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetEnrollmentQuery
Description

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

Returnosid.course.program.EnrollmentQuery an enrollment query
ErrorsUNIMPLEMENTED supportsEnrollmentQuery() is false
Complianceoptional This method must be implemented if supportsEnrollmentQuery() is true.
MethodmatchAnyEnrollment
Description

Matches entries that have any enrollment.

Parametersbooleanmatch true to match enries with any enrollment, false to match enries with no enrollments
Compliancemandatory This method must be implemented.
MethodclearEnrollmentTerms
Description

Clears the enrollment terms.

Compliancemandatory This method must be implemented.
MethodmatchCourseCatalogId
Description

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

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

Clears the course catalog Id terms.

Compliancemandatory This method must be implemented.
MethodsupportsCourseCatalogQuery
Description

Tests if a CourseCatalogQuery is available.

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

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

Returnosid.course.CourseCatalogQuery the course catalog query
ErrorsUNIMPLEMENTED supportsCourseCatalogQuery() is false
Complianceoptional This method must be implemented if supportsCourseCatalogQuery() is true.
MethodclearCourseCatalogTerms
Description

Clears the course catalog terms.

Compliancemandatory This method must be implemented.
MethodgetProgramEntryQueryRecord
Description

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

Parametersosid.type.TypeprogramEntryRecordType a program entry record type
Returnosid.course.chronicle.records.ProgramEntryQueryRecord the program entry query record
ErrorsNULL_ARGUMENT programEntryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(programEntryRecordType) is false
Compliancemandatory This method must be implemented.