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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

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 {@code supportsStudentQuery()} is {@code 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 {@code supportsAwardQuery()} is {@code 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 {@code supportsProgramQuery()} is {@code 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 {@code supportsCourseQuery()} is {@code 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 {@code supportsAssessmentQuery()} is {@code 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 {@code supportsCourseCatalogQuery()} is {@code 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.