org.osid.course.chronicle

Interface AwardEntryQuery

All Superinterfaces:

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

public interface AwardEntryQuery
extends OsidRelationshipQuery

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAssessmentIdTerms() Clears the assessment Id terms.
void	clearAssessmentTerms() Clears the assessment terms.
void	clearAwardIdTerms() Clears the award Id terms.
void	clearAwardTerms() Clears the award terms.
void	clearCourseCatalogIdTerms() Clears the course catalog Id terms.
void	clearCourseCatalogTerms() Clears the course catalog terms.
void	clearCourseIdTerms() Clears the course Id terms.
void	clearCourseTerms() Clears the course terms.
void	clearDateAwardedTerms() Clears the award date 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.
AssessmentQuery	getAssessmentQuery() Gets the query for an assessment entry.
AwardEntryQueryRecord	getAwardEntryQueryRecord(Type awardEntryRecordType) Gets the award entry query record corresponding to the given AwardEntry record Type.
AwardQuery	getAwardQuery() Gets the query for an award entry.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog.
CourseQuery	getCourseQuery() Gets the query for a course entry.
ProgramQuery	getProgramQuery() Gets the query for a program.
ResourceQuery	getStudentQuery() Gets the query for a student option.
void	matchAnyAssessment(boolean match) Matches entries that have any assessment.
void	matchAnyCourse(boolean match) Matches entries that have any course.
void	matchAnyDateAwarded(boolean match) Matches entries that have any award date.
void	matchAnyProgram(boolean match) Matches entries that have any program.
void	matchAssessmentId(Id assessmentId, boolean match) Sets the assessment Id for this query to match entries that have an entry for the given assessment,
void	matchAwardId(Id awardId, boolean match) Sets the award Id for this query to match entries that have an entry for the given course.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the course catalog Id for this query to match entries assigned to course catalogs.
void	matchCourseId(Id courseId, boolean match) Sets the course Id for this query to match entries that have an entry for the given course.
void	matchDateAwarded(DateTime from, DateTime to, boolean match) Matches award dates between the given dates inclusive.
void	matchProgramId(Id programId, boolean match) Sets the program Id for this query.
void	matchStudentId(Id resourceId, boolean match) Sets the student Id for this query.
boolean	supportsAssessmentQuery() Tests if an AssessmentQuery is available.
boolean	supportsAwardQuery() Tests if an AwardQuery is available.
boolean	supportsCourseCatalogQuery() Tests if a CourseCatalogQuery is available.
boolean	supportsCourseQuery() Tests if a CourseQuery is available.
boolean	supportsProgramQuery() Tests if a ProgramQuery is available.
boolean	supportsStudentQuery() Tests if a StudentQuery 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.

matchAwardId

void matchAwardId(Id awardId,
                boolean match)

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

Parameters:

awardId - an award Id

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

Throws:

NullArgumentException - awardId is null

Compliance:

mandatory - This method must be implemented.

clearAwardIdTerms

void clearAwardIdTerms()

Clears the award Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAwardQuery

boolean supportsAwardQuery()

Tests if an AwardQuery is available.

Returns:

true if an award query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAwardQuery

AwardQuery getAwardQuery()

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

Returns:

an award query

Throws:

UnimplementedException - supportsAwardQuery() is false

Compliance:

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

clearAwardTerms

void clearAwardTerms()

Clears the award terms.

Compliance:

mandatory - This method must be implemented.

matchDateAwarded

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

Matches award 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.

matchAnyDateAwarded

void matchAnyDateAwarded(boolean match)

Matches entries that have any award date.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDateAwardedTerms

void clearDateAwardedTerms()

Clears the award date terms.

Compliance:

mandatory - This method must be implemented.

matchProgramId

void matchProgramId(Id programId,
                  boolean match)

Sets the program Id for this query.

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. 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.

matchAnyProgram

void matchAnyProgram(boolean match)

Matches entries that have any program.

Parameters:

match - true to match entries with any program false to match entries with no program

Compliance:

mandatory - This method must be implemented.

clearProgramTerms

void clearProgramTerms()

Clears the program terms.

Compliance:

mandatory - This method must be implemented.

matchCourseId

void matchCourseId(Id courseId,
                 boolean match)

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

Parameters:

courseId - a course Id

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

Throws:

NullArgumentException - courseId is null

Compliance:

mandatory - This method must be implemented.

clearCourseIdTerms

void clearCourseIdTerms()

Clears the course Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCourseQuery

boolean supportsCourseQuery()

Tests if a CourseQuery is available.

Returns:

true if a course query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseQuery

CourseQuery getCourseQuery()

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

Returns:

a course query

Throws:

UnimplementedException - supportsCourseQuery() is false

Compliance:

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

matchAnyCourse

void matchAnyCourse(boolean match)

Matches entries that have any course.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearCourseTerms

void clearCourseTerms()

Clears the course terms.

Compliance:

mandatory - This method must be implemented.

matchAssessmentId

void matchAssessmentId(Id assessmentId,
                     boolean match)

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

Parameters:

assessmentId - an assessment Id

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

Throws:

NullArgumentException - assessmentId is null

Compliance:

mandatory - This method must be implemented.

clearAssessmentIdTerms

void clearAssessmentIdTerms()

Clears the assessment Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAssessmentQuery

boolean supportsAssessmentQuery()

Tests if an AssessmentQuery is available.

Returns:

true if an assessment query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssessmentQuery

AssessmentQuery getAssessmentQuery()

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

Returns:

an assessment query

Throws:

UnimplementedException - supportsAssessmentQuery() is false

Compliance:

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

matchAnyAssessment

void matchAnyAssessment(boolean match)

Matches entries that have any assessment.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAssessmentTerms

void clearAssessmentTerms()

Clears the assessment 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.

getAwardEntryQueryRecord

AwardEntryQueryRecord getAwardEntryQueryRecord(Type awardEntryRecordType)
                                               throws OperationFailedException

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

Parameters:

awardEntryRecordType - an award entry record type

Returns:

the award entry query record

Throws:

NullArgumentException - awardEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.