org.osid.course.chronicle

Interface ProgramEntryQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface ProgramEntryQuery
extends OsidRelationshipQuery

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAdmissionDateTerms() Clears the admission date terms.
void	clearCompleteTerms() Clears the complete terms.
void	clearCourseCatalogIdTerms() Clears the course catalog Id terms.
void	clearCourseCatalogTerms() Clears the course catalog terms.
void	clearCreditScaleIdTerms() Clears the grade system Id terms.
void	clearCreditScaleTerms() Clears the credit scale terms.
void	clearCreditsEarnedTerms() Clears the earned credits terms.
void	clearEnrollmentIdTerms() Clears the enrollment Id terms.
void	clearEnrollmentTerms() Clears the enrollment terms.
void	clearGPAScaleIdTerms() Clears the grade system Id terms.
void	clearGPAScaleTerms() Clears the credit scale terms.
void	clearGPATerms() Clears the GPA terms.
void	clearProgramIdTerms() Clears the program Id terms.
void	clearProgramTerms() Clears the program terms.
void	clearStudentIdTerms() Clears the student Id terms.
void	clearStudentTerms() Clears the student option terms.
void	clearTermIdTerms() Clears the term Id terms.
void	clearTermTerms() Clears the term terms.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog.
GradeSystemQuery	getCreditScaleQuery() Gets the query for a grade system.
EnrollmentQuery	getEnrollmentQuery() Gets the query for an enrollment entry.
GradeSystemQuery	getGPAScaleQuery() Gets the query for a grade system.
ProgramEntryQueryRecord	getProgramEntryQueryRecord(Type programEntryRecordType) Gets the program entry query record corresponding to the given ProgramEntry record Type.
ProgramQuery	getProgramQuery() Gets the query for a program entry.
ResourceQuery	getStudentQuery() Gets the query for a student option.
TermQuery	getTermQuery() Gets the query for a term entry.
void	matchAdmissionDate(DateTime from, DateTime to, boolean match) Matches admission dates between the given dates inclusive.
void	matchAnyAdmissionDate(boolean match) Matches entries that have any admission date.
void	matchAnyCreditScale(boolean match) Matches entries that have any credit scale.
void	matchAnyCreditsEarned(boolean match) Matches entries that have any earned credits.
void	matchAnyEnrollment(boolean match) Matches entries that have any enrollment.
void	matchAnyGPA(boolean match) Matches entries that have any GPA.
void	matchAnyGPAScale(boolean match) Matches entries that have any GPA scale.
void	matchAnyTerm(boolean match) Matches entries that have any term.
void	matchComplete(boolean match) Matches completed programs.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the course catalog Id for this query to match entries assigned to course catalogs.
void	matchCreditScaleId(Id gradeSystemId, boolean match) Matches a credit scale Id.
void	matchCreditsEarned(java.math.BigDecimal from, java.math.BigDecimal to, boolean match) Matches earned credits between the given range inclusive.
void	matchEnrollmentId(Id enrollmentId, boolean match) Sets the enrollment Id for this query.
void	matchGPA(java.math.BigDecimal from, java.math.BigDecimal to, boolean match) Matches GPA between the given range inclusive.
void	matchGPAScaleId(Id gradeSystemId, boolean match) Matches a GPA scale Id.
void	matchProgramId(Id programId, boolean match) Sets the program Id for this query to match entries that have an entry for the given course.
void	matchStudentId(Id resourceId, boolean match) Sets the student Id for this query.
void	matchTermId(Id termId, boolean match) Sets the term Id for this query.
boolean	supportsCourseCatalogQuery() Tests if a CourseCatalogQuery is available.
boolean	supportsCreditScaleQuery() Tests if a GradeSystemQuery is available.
boolean	supportsEnrollmentQuery() Tests if an EnrollmentQuery is available.
boolean	supportsGPAScaleQuery() Tests if a GradeSystemQuery is available.
boolean	supportsProgramQuery() Tests if a ProgramQuery is available.
boolean	supportsStudentQuery() Tests if a StudentQuery is available.
boolean	supportsTermQuery() Tests if a TermQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchStudentId

void matchStudentId(Id resourceId,
                  boolean match)

Sets the student Id for this query.

Parameters:

resourceId - a resource Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearStudentIdTerms

void clearStudentIdTerms()

Clears the student Id terms.

Compliance:

mandatory - This method must be implemented.

supportsStudentQuery

boolean supportsStudentQuery()

Tests if a StudentQuery is available.

Returns:

true if a student query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStudentQuery

ResourceQuery getStudentQuery()

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

Returns:

a student query

Throws:

UnimplementedException - supportsStudentQuery() is false

Compliance:

optional - This method must be implemented if supportsStudentQuery() is true.

clearStudentTerms

void clearStudentTerms()

Clears the student option terms.

Compliance:

mandatory - This method must be implemented.

matchProgramId

void matchProgramId(Id programId,
                  boolean match)

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

Parameters:

programId - a program Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - programId is null

Compliance:

mandatory - This method must be implemented.

clearProgramIdTerms

void clearProgramIdTerms()

Clears the program Id terms.

Compliance:

mandatory - This method must be implemented.

supportsProgramQuery

boolean supportsProgramQuery()

Tests if a ProgramQuery is available.

Returns:

true if a program query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProgramQuery

ProgramQuery getProgramQuery()

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

Returns:

a program query

Throws:

UnimplementedException - supportsProgramQuery() is false

Compliance:

optional - This method must be implemented if supportsProgramQuery() is true.

clearProgramTerms

void clearProgramTerms()

Clears the program terms.

Compliance:

mandatory - This method must be implemented.

matchAdmissionDate

void matchAdmissionDate(DateTime from,
                      DateTime to,
                      boolean match)

Matches admission dates between the given dates inclusive.

Parameters:

from - starting date

to - ending date

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyAdmissionDate

void matchAnyAdmissionDate(boolean match)

Matches entries that have any admission date.

Parameters:

match - true to match entries with any admission date, false to match entries with no admission date

Compliance:

mandatory - This method must be implemented.

clearAdmissionDateTerms

void clearAdmissionDateTerms()

Clears the admission date terms.

Compliance:

mandatory - This method must be implemented.

matchComplete

void matchComplete(boolean match)

Matches completed programs.

Parameters:

match - true if a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearCompleteTerms

void clearCompleteTerms()

Clears the complete terms.

Compliance:

mandatory - This method must be implemented.

matchTermId

void matchTermId(Id termId,
               boolean match)

Sets the term Id for this query.

Parameters:

termId - a term Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - termId is null

Compliance:

mandatory - This method must be implemented.

clearTermIdTerms

void clearTermIdTerms()

Clears the term Id terms.

Compliance:

mandatory - This method must be implemented.

supportsTermQuery

boolean supportsTermQuery()

Tests if a TermQuery is available.

Returns:

true if a term query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTermQuery

TermQuery getTermQuery()

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

Returns:

a term query

Throws:

UnimplementedException - supportsTermQuery() is false

Compliance:

optional - This method must be implemented if supportsTermQuery() is true.

matchAnyTerm

void matchAnyTerm(boolean match)

Matches entries that have any term.

Parameters:

match - true to match entries specific to a term, false to match entries for the entire enrollment

Compliance:

mandatory - This method must be implemented.

clearTermTerms

void clearTermTerms()

Clears the term terms.

Compliance:

mandatory - This method must be implemented.

matchCreditScaleId

void matchCreditScaleId(Id gradeSystemId,
                      boolean match)

Matches a credit scale Id.

Parameters:

gradeSystemId - a grade system Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearCreditScaleIdTerms

void clearCreditScaleIdTerms()

Clears the grade system Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCreditScaleQuery

boolean supportsCreditScaleQuery()

Tests if a GradeSystemQuery is available.

Returns:

true if a grade system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCreditScaleQuery

GradeSystemQuery getCreditScaleQuery()

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

Returns:

a grade system query

Throws:

UnimplementedException - supportsCreditScaleQuery() is false

Compliance:

optional - This method must be implemented if supportsCreditScaleQuery() is true.

matchAnyCreditScale

void matchAnyCreditScale(boolean match)

Matches entries that have any credit scale.

Parameters:

match - true to match entries with any credit scale, false to match entries with no credit scale

Compliance:

mandatory - This method must be implemented.

clearCreditScaleTerms

void clearCreditScaleTerms()

Clears the credit scale terms.

Compliance:

mandatory - This method must be implemented.

matchCreditsEarned

void matchCreditsEarned(java.math.BigDecimal from,
                      java.math.BigDecimal to,
                      boolean match)

Matches earned credits between the given range inclusive.

Parameters:

from - starting value

to - ending value

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyCreditsEarned

void matchAnyCreditsEarned(boolean match)

Matches entries that have any earned credits.

Parameters:

match - true to match entries with any earned credits, false to match entries with no earned credits

Compliance:

mandatory - This method must be implemented.

clearCreditsEarnedTerms

void clearCreditsEarnedTerms()

Clears the earned credits terms.

Compliance:

mandatory - This method must be implemented.

matchGPAScaleId

void matchGPAScaleId(Id gradeSystemId,
                   boolean match)

Matches a GPA scale Id.

Parameters:

gradeSystemId - a grade system Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearGPAScaleIdTerms

void clearGPAScaleIdTerms()

Clears the grade system Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGPAScaleQuery

boolean supportsGPAScaleQuery()

Tests if a GradeSystemQuery is available.

Returns:

true if a grade system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGPAScaleQuery

GradeSystemQuery getGPAScaleQuery()

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

Returns:

a grade system query

Throws:

UnimplementedException - supportsGPAScaleQuery() is false

Compliance:

optional - This method must be implemented if supportsGPAScaleQuery() is true.

matchAnyGPAScale

void matchAnyGPAScale(boolean match)

Matches entries that have any GPA scale.

Parameters:

match - true to match entries with any GPA scale, false to match entries with no GPA scale

Compliance:

mandatory - This method must be implemented.

clearGPAScaleTerms

void clearGPAScaleTerms()

Clears the credit scale terms.

Compliance:

mandatory - This method must be implemented.

matchGPA

void matchGPA(java.math.BigDecimal from,
            java.math.BigDecimal to,
            boolean match)

Matches GPA between the given range inclusive.

Parameters:

from - starting value

to - ending value

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyGPA

void matchAnyGPA(boolean match)

Matches entries that have any GPA.

Parameters:

match - true to match entries with any GPA, false to match entries with no GPA

Compliance:

mandatory - This method must be implemented.

clearGPATerms

void clearGPATerms()

Clears the GPA terms.

Compliance:

mandatory - This method must be implemented.

matchEnrollmentId

void matchEnrollmentId(Id enrollmentId,
                     boolean match)

Sets the enrollment Id for this query.

Parameters:

enrollmentId - an enrollment Id

match - true if a positive match, false for a negative match

Throws:

NullArgumentException - enrollmentId is null

Compliance:

mandatory - This method must be implemented.

clearEnrollmentIdTerms

void clearEnrollmentIdTerms()

Clears the enrollment Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEnrollmentQuery

boolean supportsEnrollmentQuery()

Tests if an EnrollmentQuery is available.

Returns:

true if an enrollment query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEnrollmentQuery

EnrollmentQuery getEnrollmentQuery()

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

Returns:

an enrollment query

Throws:

UnimplementedException - supportsEnrollmentQuery() is false

Compliance:

optional - This method must be implemented if supportsEnrollmentQuery() is true.

matchAnyEnrollment

void matchAnyEnrollment(boolean match)

Matches entries that have any enrollment.

Parameters:

match - true to match enries with any enrollment, false to match enries with no enrollments

Compliance:

mandatory - This method must be implemented.

clearEnrollmentTerms

void clearEnrollmentTerms()

Clears the enrollment terms.

Compliance:

mandatory - This method must be implemented.

matchCourseCatalogId

void matchCourseCatalogId(Id courseCatalogId,
                        boolean match)

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

Parameters:

courseCatalogId - the course catalog Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - courseCatalogId is null

Compliance:

mandatory - This method must be implemented.

clearCourseCatalogIdTerms

void clearCourseCatalogIdTerms()

Clears the course catalog Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCourseCatalogQuery

boolean supportsCourseCatalogQuery()

Tests if a CourseCatalogQuery is available.

Returns:

true if a course catalog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseCatalogQuery

CourseCatalogQuery getCourseCatalogQuery()

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

Returns:

the course catalog query

Throws:

UnimplementedException - supportsCourseCatalogQuery() is false

Compliance:

optional - This method must be implemented if supportsCourseCatalogQuery() is true.

clearCourseCatalogTerms

void clearCourseCatalogTerms()

Clears the course catalog terms.

Compliance:

mandatory - This method must be implemented.

getProgramEntryQueryRecord

ProgramEntryQueryRecord getProgramEntryQueryRecord(Type programEntryRecordType)
                                                   throws OperationFailedException

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

Parameters:

programEntryRecordType - a program entry record type

Returns:

the program entry query record

Throws:

NullArgumentException - programEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.