org.osid.assessment

Interface AssessmentTakenQuery

All Superinterfaces:

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

public interface AssessmentTakenQuery
extends OsidObjectQuery

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	clearActualStartTimeTerms() Clears all start time terms.
void	clearAssessmentOfferedIdTerms() Clears all assessment offered Id terms.
void	clearAssessmentOfferedTerms() Clears all assessment offered terms.
void	clearBankIdTerms() Clears all bank Id terms.
void	clearBankTerms() Clears all bank terms.
void	clearCompletionTimeTerms() Clears all in completion time terms.
void	clearFeedbackTerms() Clears all comment terms.
void	clearGradeIdTerms() Clears all grade Id terms.
void	clearGradeTerms() Clears all grade terms.
void	clearRubricIdTerms() Clears all rubric assessment taken Id terms.
void	clearRubricTerms() Clears all rubric assessment taken terms.
void	clearScoreSystemIdTerms() Clears all grade system Id terms.
void	clearScoreSystemTerms() Clears all grade system terms.
void	clearScoreTerms() Clears all score terms.
void	clearTakerIdTerms() Clears all resource Id terms.
void	clearTakerTerms() Clears all resource terms.
void	clearTakingAgentIdTerms() Clears all agent Id terms.
void	clearTakingAgentTerms() Clears all taking agent terms.
void	clearTimeSpentTerms() Clears all in time spent terms.
AssessmentOfferedQuery	getAssessmentOfferedQuery() Gets the query for an assessment.
AssessmentTakenQueryRecord	getAssessmentTakenQueryRecord(Type assessmentTakenRecordType) Gets the assessment taken query record corresponding to the given AssessmentTaken record Type.
BankQuery	getBankQuery() Gets the query for a bank.
GradeQuery	getGradeQuery() Gets the query for a grade.
AssessmentTakenQuery	getRubricQuery() Gets the query for a rubric assessment.
GradeSystemQuery	getScoreSystemQuery() Gets the query for a grade system.
ResourceQuery	getTakerQuery() Gets the query for a resource.
AgentQuery	getTakingAgentQuery() Gets the query for an agent.
void	matchActualStartTime(DateTime start, DateTime end, boolean match) Matches assessments whose start time falls between the specified range inclusive.
void	matchAnyActualStartTime(boolean match) Matches taken assessments taken that have begun.
void	matchAnyCompletionTime(boolean match) Matches taken assessments taken that have completed.
void	matchAnyFeedback(boolean match) Matches taken assessments that have any comments.
void	matchAnyGrade(boolean match) Matches taken assessments that have any grade assigned.
void	matchAnyRubric(boolean match) Matches an assessment taken that has any rubric assessment assigned.
void	matchAnyScore(boolean match) Matches taken assessments that have any score assigned.
void	matchAnyScoreSystem(boolean match) Matches taken assessments that have any grade system assigned.
void	matchAssessmentOfferedId(Id assessmentOfferedId, boolean match) Sets the assessment offered Id for this query.
void	matchBankId(Id bankId, boolean match) Sets the bank Id for this query.
void	matchCompletionTime(DateTime start, DateTime end, boolean match) Matches assessments whose completion time falls between the specified range inclusive.
void	matchFeedback(java.lang.String comments, Type stringMatchType, boolean match) Sets the comment string for this query.
void	matchGradeId(Id gradeId, boolean match) Sets the grade Id for this query.
void	matchRubricId(Id assessmentTakenId, boolean match) Sets the rubric assessment taken Id for this query.
void	matchScore(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches assessments whose score falls between the specified range inclusive.
void	matchScoreSystemId(Id gradeSystemId, boolean match) Sets the grade system Id for this query.
void	matchTakerId(Id resourceId, boolean match) Sets the resource Id for this query.
void	matchTakingAgentId(Id agentId, boolean match) Sets the agent Id for this query.
void	matchTimeSpent(Duration low, Duration high, boolean match) Matches assessments where the time spent falls between the specified range inclusive.
boolean	supportsAssessmentOfferedQuery() Tests if an AssessmentOfferedQuery is available.
boolean	supportsBankQuery() Tests if a BankQuery is available.
boolean	supportsGradeQuery() Tests if a GradeQuery is available.
boolean	supportsRubricQuery() Tests if an AssessmentTakenQuery is available.
boolean	supportsScoreSystemQuery() Tests if a GradeSystemQuery is available.
boolean	supportsTakerQuery() Tests if a ResourceQuery is available.
boolean	supportsTakingAgentQuery() Tests if an AgentQuery 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

matchAssessmentOfferedId

void matchAssessmentOfferedId(Id assessmentOfferedId,
                            boolean match)

Sets the assessment offered Id for this query.

Parameters:

assessmentOfferedId - an assessment Id

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

Throws:

NullArgumentException - assessmentOfferedId is null

Compliance:

mandatory - This method must be implemented.

clearAssessmentOfferedIdTerms

void clearAssessmentOfferedIdTerms()

Clears all assessment offered Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAssessmentOfferedQuery

boolean supportsAssessmentOfferedQuery()

Tests if an AssessmentOfferedQuery is available.

Returns:

true if an assessment offered query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAssessmentOfferedQuery

AssessmentOfferedQuery getAssessmentOfferedQuery()

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

Returns:

the assessment offered query

Throws:

UnimplementedException - supportsAssessmentOfferedQuery() is false

Compliance:

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

clearAssessmentOfferedTerms

void clearAssessmentOfferedTerms()

Clears all assessment offered terms.

Compliance:

mandatory - This method must be implemented.

matchTakerId

void matchTakerId(Id resourceId,
                boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearTakerIdTerms

void clearTakerIdTerms()

Clears all resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsTakerQuery

boolean supportsTakerQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTakerQuery

ResourceQuery getTakerQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsTakerQuery() is false

Compliance:

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

clearTakerTerms

void clearTakerTerms()

Clears all resource terms.

Compliance:

mandatory - This method must be implemented.

matchTakingAgentId

void matchTakingAgentId(Id agentId,
                      boolean match)

Sets the agent Id for this query.

Parameters:

agentId - an agent Id

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

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearTakingAgentIdTerms

void clearTakingAgentIdTerms()

Clears all agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsTakingAgentQuery

boolean supportsTakingAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTakingAgentQuery

AgentQuery getTakingAgentQuery()

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

Returns:

the agent query

Throws:

UnimplementedException - supportsTakingAgentQuery() is false

Compliance:

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

clearTakingAgentTerms

void clearTakingAgentTerms()

Clears all taking agent terms.

Compliance:

mandatory - This method must be implemented.

matchActualStartTime

void matchActualStartTime(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

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyActualStartTime

void matchAnyActualStartTime(boolean match)

Matches taken assessments taken that have begun.

Parameters:

match - true to match assessments taken started, false to match assessments taken that have not begun

Compliance:

mandatory - This method must be implemented.

clearActualStartTimeTerms

void clearActualStartTimeTerms()

Clears all start time terms.

Compliance:

mandatory - This method must be implemented.

matchCompletionTime

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

Matches assessments whose completion 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.

matchAnyCompletionTime

void matchAnyCompletionTime(boolean match)

Matches taken assessments taken that have completed.

Parameters:

match - true to match assessments taken completed, false to match assessments taken that are incomplete

Compliance:

mandatory - This method must be implemented.

clearCompletionTimeTerms

void clearCompletionTimeTerms()

Clears all in completion time terms.

Compliance:

mandatory - This method must be implemented.

matchTimeSpent

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

Matches assessments where the time spent falls between the specified range inclusive.

Parameters:

low - start of duration range

high - end of duration range

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

Throws:

InvalidArgumentException - high is less than low

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

clearTimeSpentTerms

void clearTimeSpentTerms()

Clears all in time spent 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.

matchScore

void matchScore(java.math.BigDecimal low,
              java.math.BigDecimal high,
              boolean match)

Matches assessments whose score falls between the specified range inclusive.

Parameters:

low - start of range

high - end of range

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

Throws:

InvalidArgumentException - high is less than low

Compliance:

mandatory - This method must be implemented.

matchAnyScore

void matchAnyScore(boolean match)

Matches taken assessments that have any score assigned.

Parameters:

match - true to match assessments with any score, false to match assessments with no score

Compliance:

mandatory - This method must be implemented.

clearScoreTerms

void clearScoreTerms()

Clears all score terms.

Compliance:

mandatory - This method must be implemented.

matchGradeId

void matchGradeId(Id gradeId,
                boolean match)

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

clearGradeIdTerms

void clearGradeIdTerms()

Clears all grade Id terms.

Compliance:

mandatory - This method must be implemented.

supportsGradeQuery

boolean supportsGradeQuery()

Tests if a GradeQuery is available.

Returns:

true if a grade query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeQuery

GradeQuery getGradeQuery()

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

Returns:

the grade query

Throws:

UnimplementedException - supportsGradeQuery() is false

Compliance:

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

matchAnyGrade

void matchAnyGrade(boolean match)

Matches taken assessments that have any grade assigned.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearGradeTerms

void clearGradeTerms()

Clears all grade terms.

Compliance:

mandatory - This method must be implemented.

matchFeedback

void matchFeedback(java.lang.String comments,
                 Type stringMatchType,
                 boolean match)

Sets the comment string for this query.

Parameters:

comments - comment string

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - comments is not of stringMatchType

NullArgumentException - comments or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyFeedback

void matchAnyFeedback(boolean match)

Matches taken assessments that have any comments.

Parameters:

match - true to match assessments with any comments, false to match assessments with no comments

Compliance:

mandatory - This method must be implemented.

clearFeedbackTerms

void clearFeedbackTerms()

Clears all comment terms.

Compliance:

mandatory - This method must be implemented.

matchRubricId

void matchRubricId(Id assessmentTakenId,
                 boolean match)

Sets the rubric 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.

clearRubricIdTerms

void clearRubricIdTerms()

Clears all rubric assessment taken Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRubricQuery

boolean supportsRubricQuery()

Tests if an AssessmentTakenQuery is available.

Returns:

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

Compliance:

mandatory - This method must be implemented.

getRubricQuery

AssessmentTakenQuery getRubricQuery()

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

Returns:

the assessment taken 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 taken that has any rubric assessment assigned.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRubricTerms

void clearRubricTerms()

Clears all rubric 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.

getAssessmentTakenQueryRecord

AssessmentTakenQueryRecord getAssessmentTakenQueryRecord(Type assessmentTakenRecordType)
                                                         throws OperationFailedException

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

Parameters:

assessmentTakenRecordType - an assessment taken record type

Returns:

the assessment taken query record

Throws:

NullArgumentException - assessmentTakenRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentTakenRecordType) is false

Compliance:

mandatory - This method must be implemented.