org.osid.assessment

Interface AssessmentOfferedQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

public interface AssessmentOfferedQuery
extends OsidObjectQuery, OsidSubjugateableQuery

This is the query for searching assessments. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAssessmentIdTerms() Clears all assessment Id terms.
void	clearAssessmentTakenIdTerms() Clears all assessment taken Id terms.
void	clearAssessmentTakenTerms() Clears all assessment taken terms.
void	clearAssessmentTerms() Clears all assessment terms.
void	clearBankIdTerms() Clears all bank Id terms.
void	clearBankTerms() Clears all bank terms.
void	clearDeadlineTerms() Clears all deadline terms.
void	clearDurationTerms() Clears all duration terms.
void	clearGradeSystemIdTerms() Clears all grade system Id terms.
void	clearGradeSystemTerms() Clears all grade system terms.
void	clearItemsSequentialTerms() Clears all sequential terms.
void	clearItemsShuffledTerms() Clears all shuffled terms.
void	clearLevelIdTerms() Clears all level Id terms.
void	clearLevelTerms() Clears all level terms.
void	clearRubricIdTerms() Clears all rubric assessment offered Id terms.
void	clearRubricTerms() Clears all rubric assessment terms.
void	clearScoreSystemIdTerms() Clears all grade system Id terms.
void	clearScoreSystemTerms() Clears all grade system terms.
void	clearStartTimeTerms() Clears all scheduled terms.
AssessmentOfferedQueryRecord	getAssessmentOfferedQueryRecord(Type assessmentOfferedRecordType) Gets the assessment offered query record corresponding to the given AssessmentOffered record Type.
AssessmentQuery	getAssessmentQuery() Gets the query for an assessment.
AssessmentTakenQuery	getAssessmentTakenQuery() Gets the query for an assessment taken.
BankQuery	getBankQuery() Gets the query for a bank.
GradeSystemQuery	getGradeSystemQuery() Gets the query for a grade system.
GradeQuery	getLevelQuery() Gets the query for a grade.
AssessmentOfferedQuery	getRubricQuery() Gets the query for a rubric assessment.
GradeSystemQuery	getScoreSystemQuery() Gets the query for a grade system.
void	matchAnyAssessmentTaken(boolean match) Matches offerings that have any taken assessment version.
void	matchAnyDeadline(boolean match) Matches offerings that have any deadline assigned.
void	matchAnyDuration(boolean match) Matches offerings that have any duration assigned.
void	matchAnyGradeSystem(boolean match) Matches taken assessments that have any grade system assigned.
void	matchAnyLevel(boolean match) Matches an assessment offered that has any level assigned.
void	matchAnyRubric(boolean match) Matches an assessment offered that has any rubric assessment assigned.
void	matchAnyScoreSystem(boolean match) Matches taken assessments that have any grade system assigned.
void	matchAnyStartTime(boolean match) Matches offerings that has any start time assigned.
void	matchAssessmentId(Id assessmentId, boolean match) Sets the assessment Id for this query.
void	matchAssessmentTakenId(Id assessmentTakenId, boolean match) Sets the assessment taken Id for this query.
void	matchBankId(Id bankId, boolean match) Sets the bank Id for this query.
void	matchDeadline(DateTime start, DateTime end, boolean match) Matches assessments whose end time falls between the specified range inclusive.
void	matchDuration(Duration low, Duration high, boolean match) Matches assessments whose duration falls between the specified range inclusive.
void	matchGradeSystemId(Id gradeSystemId, boolean match) Sets the grade system Id for this query.
void	matchItemsSequential(boolean match) Match sequential assessments.
void	matchItemsShuffled(boolean match) Match shuffled item assessments.
void	matchLevelId(Id gradeId, boolean match) Sets the level grade Id for this query.
void	matchRubricId(Id assessmentOfferedId, boolean match) Sets the rubric assessment offered Id for this query.
void	matchScoreSystemId(Id gradeSystemId, boolean match) Sets the grade system Id for this query.
void	matchStartTime(DateTime start, DateTime end, boolean match) Matches assessments whose start time falls between the specified range inclusive.
boolean	supportsAssessmentQuery() Tests if an AssessmentQuery is available.
boolean	supportsAssessmentTakenQuery() Tests if an AssessmentTakenQuery is available.
boolean	supportsBankQuery() Tests if a BankQuery is available.
boolean	supportsGradeSystemQuery() Tests if a GradeSystemQuery is available.
boolean	supportsLevelQuery() Tests if a GradeQuery is available.
boolean	supportsRubricQuery() Tests if an AssessmentOfferedQuery is available.
boolean	supportsScoreSystemQuery() Tests if a GradeSystemQuery is available.

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

Method Detail

matchAssessmentId

void matchAssessmentId(Id assessmentId,
                     boolean match)

Sets the assessment Id for this query.

Parameters:

assessmentId - an assessment Id

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

Throws:

NullArgumentException - assessmentId is null

Compliance:

mandatory - This method must be implemented.

clearAssessmentIdTerms

void clearAssessmentIdTerms()

Clears all 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. Multiple retrievals produce a nested OR term.

Returns:

the assessment query

Throws:

UnimplementedException - supportsAssessmentQuery() is false

Compliance:

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

clearAssessmentTerms

void clearAssessmentTerms()

Clears all assessment terms.

Compliance:

mandatory - This method must be implemented.

matchLevelId

void matchLevelId(Id gradeId,
                boolean match)

Sets the level grade Id for this query.

Parameters:

gradeId - a grade Id

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

Throws:

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearLevelIdTerms

void clearLevelIdTerms()

Clears all level Id terms.

Compliance:

mandatory - This method must be implemented.

supportsLevelQuery

boolean supportsLevelQuery()

Tests if a GradeQuery is available.

Returns:

true if a grade query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLevelQuery

GradeQuery getLevelQuery()

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

Returns:

the grade query

Throws:

UnimplementedException - supportsLevelQuery() is false

Compliance:

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

matchAnyLevel

void matchAnyLevel(boolean match)

Matches an assessment offered that has any level assigned.

Parameters:

match - true to match offerings with any level, false to match offerings with no levsls

Compliance:

mandatory - This method must be implemented.

clearLevelTerms

void clearLevelTerms()

Clears all level terms.

Compliance:

mandatory - This method must be implemented.

matchItemsSequential

void matchItemsSequential(boolean match)

Match sequential assessments.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearItemsSequentialTerms

void clearItemsSequentialTerms()

Clears all sequential terms.

Compliance:

mandatory - This method must be implemented.

matchItemsShuffled

void matchItemsShuffled(boolean match)

Match shuffled item assessments.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearItemsShuffledTerms

void clearItemsShuffledTerms()

Clears all shuffled terms.

Compliance:

mandatory - This method must be implemented.

matchStartTime

void matchStartTime(DateTime start,
                  DateTime end,
                  boolean match)

Matches assessments whose start time falls between the specified range inclusive.

Parameters:

start - start of range

end - end of range

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

Throws:

InvalidArgumentException - end is less than start

Compliance:

mandatory - This method must be implemented.

matchAnyStartTime

void matchAnyStartTime(boolean match)

Matches offerings that has any start time assigned.

Parameters:

match - true to match offerings with any start time, false to match offerings with no start time

Compliance:

mandatory - This method must be implemented.

clearStartTimeTerms

void clearStartTimeTerms()

Clears all scheduled terms.

Compliance:

mandatory - This method must be implemented.

matchDeadline

void matchDeadline(DateTime start,
                 DateTime end,
                 boolean match)

Matches assessments whose end time falls between the specified range inclusive.

Parameters:

start - start of range

end - end of range

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

Throws:

InvalidArgumentException - end is less than start

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyDeadline

void matchAnyDeadline(boolean match)

Matches offerings that have any deadline assigned.

Parameters:

match - true to match offerings with any deadline, false to match offerings with no deadline

Compliance:

mandatory - This method must be implemented.

clearDeadlineTerms

void clearDeadlineTerms()

Clears all deadline terms.

Compliance:

mandatory - This method must be implemented.

matchDuration

void matchDuration(Duration low,
                 Duration high,
                 boolean match)

Matches assessments whose duration falls between the specified range inclusive.

Parameters:

low - start range of duration

high - end range of duration

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

Throws:

InvalidArgumentException - end is less than start

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyDuration

void matchAnyDuration(boolean match)

Matches offerings that have any duration assigned.

Parameters:

match - true to match offerings with any duration, false to match offerings with no duration

Compliance:

mandatory - This method must be implemented.

clearDurationTerms

void clearDurationTerms()

Clears all duration terms.

Compliance:

mandatory - This method must be implemented.

matchScoreSystemId

void matchScoreSystemId(Id gradeSystemId,
                      boolean match)

Sets the grade system Id for this query.

Parameters:

gradeSystemId - a grade system Id

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

Throws:

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearScoreSystemIdTerms

void clearScoreSystemIdTerms()

Clears all grade system Id terms.

Compliance:

mandatory - This method must be implemented.

supportsScoreSystemQuery

boolean supportsScoreSystemQuery()

Tests if a GradeSystemQuery is available.

Returns:

true if a grade system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getScoreSystemQuery

GradeSystemQuery getScoreSystemQuery()

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

Returns:

the grade system query

Throws:

UnimplementedException - supportsScoreSystemQuery() is false

Compliance:

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

matchAnyScoreSystem

void matchAnyScoreSystem(boolean match)

Matches taken assessments that have any grade system assigned.

Parameters:

match - true to match assessments with any grade system, false to match assessments with no grade system

Compliance:

mandatory - This method must be implemented.

clearScoreSystemTerms

void clearScoreSystemTerms()

Clears all grade system terms.

Compliance:

mandatory - This method must be implemented.

matchGradeSystemId

void matchGradeSystemId(Id gradeSystemId,
                      boolean match)

Sets the grade system Id for this query.

Parameters:

gradeSystemId - a grade system Id

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

Throws:

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearGradeSystemIdTerms

void clearGradeSystemIdTerms()

Clears all grade system Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGradeSystemQuery

boolean supportsGradeSystemQuery()

Tests if a GradeSystemQuery is available.

Returns:

true if a grade system query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeSystemQuery

GradeSystemQuery getGradeSystemQuery()

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

Returns:

the grade system query

Throws:

UnimplementedException - supportsScoreSystemQuery() is false

Compliance:

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

matchAnyGradeSystem

void matchAnyGradeSystem(boolean match)

Matches taken assessments that have any grade system assigned.

Parameters:

match - true to match assessments with any grade system, false to match assessments with no grade system

Compliance:

mandatory - This method must be implemented.

clearGradeSystemTerms

void clearGradeSystemTerms()

Clears all grade system terms.

Compliance:

mandatory - This method must be implemented.

matchRubricId

void matchRubricId(Id assessmentOfferedId,
                 boolean match)

Sets the rubric assessment offered Id for this query.

Parameters:

assessmentOfferedId - an assessment offered Id

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

Throws:

NullArgumentException - assessmentOfferedId is null

Compliance:

mandatory - This method must be implemented.

clearRubricIdTerms

void clearRubricIdTerms()

Clears all rubric assessment offered Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRubricQuery

boolean supportsRubricQuery()

Tests if an AssessmentOfferedQuery is available.

Returns:

true if a rubric assessment offered query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRubricQuery

AssessmentOfferedQuery getRubricQuery()

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

Returns:

the assessment offered query

Throws:

UnimplementedException - supportsRubricQuery() is false

Compliance:

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

matchAnyRubric

void matchAnyRubric(boolean match)

Matches an assessment offered that has any rubric assessment assigned.

Parameters:

match - true to match assessments offered with any rubric, false to match assessments offered with no rubric

Compliance:

mandatory - This method must be implemented.

clearRubricTerms

void clearRubricTerms()

Clears all rubric assessment terms.

Compliance:

mandatory - This method must be implemented.

matchAssessmentTakenId

void matchAssessmentTakenId(Id assessmentTakenId,
                          boolean match)

Sets the assessment taken Id for this query.

Parameters:

assessmentTakenId - an assessment taken Id

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

Throws:

NullArgumentException - assessmentTakenId is null

Compliance:

mandatory - This method must be implemented.

clearAssessmentTakenIdTerms

void clearAssessmentTakenIdTerms()

Clears all assessment taken Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAssessmentTakenQuery

boolean supportsAssessmentTakenQuery()

Tests if an AssessmentTakenQuery is available.

Returns:

true if an assessment taken query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssessmentTakenQuery

AssessmentTakenQuery getAssessmentTakenQuery()

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

Returns:

the assessment taken query

Throws:

UnimplementedException - supportsAssessmentTakenQuery() is false

Compliance:

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

matchAnyAssessmentTaken

void matchAnyAssessmentTaken(boolean match)

Matches offerings that have any taken assessment version.

Parameters:

match - true to match offerings with any taken assessment, false to match offerings with no assessmen taken

Compliance:

mandatory - This method must be implemented.

clearAssessmentTakenTerms

void clearAssessmentTakenTerms()

Clears all assessment taken terms.

Compliance:

mandatory - This method must be implemented.

matchBankId

void matchBankId(Id bankId,
               boolean match)

Sets the bank Id for this query.

Parameters:

bankId - a bank Id

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

Throws:

NullArgumentException - bankId is null

Compliance:

mandatory - This method must be implemented.

clearBankIdTerms

void clearBankIdTerms()

Clears all bank Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBankQuery

boolean supportsBankQuery()

Tests if a BankQuery is available.

Returns:

true if a bank query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBankQuery

BankQuery getBankQuery()

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

Returns:

the bank query

Throws:

UnimplementedException - supportsBankQuery() is false

Compliance:

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

clearBankTerms

void clearBankTerms()

Clears all bank terms.

Compliance:

mandatory - This method must be implemented.

getAssessmentOfferedQueryRecord

AssessmentOfferedQueryRecord getAssessmentOfferedQueryRecord(Type assessmentOfferedRecordType)
                                                             throws OperationFailedException

Gets the assessment offered query record corresponding to the given AssessmentOffered record Type. Multiple retrievals produce a nested OR term.

Parameters:

assessmentOfferedRecordType - an assessment offered record type

Returns:

the assessment offered query record

Throws:

NullArgumentException - assessmentOfferedRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentOfferedRecordType) is false

Compliance:

mandatory - This method must be implemented.