public interface ItemQuery extends OsidObjectQuery, OsidAggregateableQuery
This is the query for searching items. Each method match request
produces an AND
term while multiple invocations of a method
produces a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAnswerIdTerms()
Clears all answer
Id terms. |
void |
clearAnswerTerms()
Clears all answer terms.
|
void |
clearAssessmentIdTerms()
Clears all assessment
Id terms. |
void |
clearAssessmentTerms()
Clears all assessment terms.
|
void |
clearBankIdTerms()
Clears all bank
Id terms. |
void |
clearBankTerms()
Clears all bank terms.
|
void |
clearLearningObjectiveIdTerms()
Clears all learning objective
Id terms. |
void |
clearLearningObjectiveTerms()
Clears all learning objective terms.
|
void |
clearQuestionIdTerms()
Clears all question
Id terms. |
void |
clearQuestionTerms()
Clears all question terms.
|
AnswerQuery |
getAnswerQuery()
Gets the query for an answer.
|
AssessmentQuery |
getAssessmentQuery()
Gets the query for an assessment.
|
BankQuery |
getBankQuery()
Gets the query for a bank.
|
ItemQueryRecord |
getItemQueryRecord(Type itemRecordType)
Gets the item record query corresponding to the given
Item
record Type. |
ObjectiveQuery |
getLearningObjectiveQuery()
Gets the query for a learning objective.
|
QuestionQuery |
getQuestionQuery()
Gets the query for a question.
|
void |
matchAnswerId(Id answerId,
boolean match)
Sets the answer
Id for this query. |
void |
matchAnyAnswer(boolean match)
Matches an item with any answer.
|
void |
matchAnyAssessment(boolean match)
Matches an item with any assessment.
|
void |
matchAnyLearningObjective(boolean match)
Matches an item with any objective.
|
void |
matchAnyQuestion(boolean match)
Matches an item with any question.
|
void |
matchAssessmentId(Id assessmentId,
boolean match)
Sets the assessment
Id for this query. |
void |
matchBankId(Id bankId,
boolean match)
Sets the bank
Id for this query. |
void |
matchLearningObjectiveId(Id objectiveId,
boolean match)
Sets the learning objective
Id for this query. |
void |
matchQuestionId(Id questionId,
boolean match)
Sets the question
Id for this query. |
boolean |
supportsAnswerQuery()
Tests if an
AnswerQuery is available. |
boolean |
supportsAssessmentQuery()
Tests if an
AssessmentQuery is available. |
boolean |
supportsBankQuery()
Tests if a
BankQuery is available. |
boolean |
supportsLearningObjectiveQuery()
Tests if an
ObjectiveQuery is available. |
boolean |
supportsQuestionQuery()
Tests if a
QuestionQuery is available. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchLearningObjectiveId(Id objectiveId, boolean match)
Id
for this query.objectiveId
- a learning objective Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- objectiveId
is
null
mandatory
- This method must be implemented. void clearLearningObjectiveIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsLearningObjectiveQuery()
ObjectiveQuery
is available. true
if a learning objective query is
available, false
otherwisemandatory
- This method must be implemented. ObjectiveQuery getLearningObjectiveQuery()
OR
term.UnimplementedException
-
supportsLearningObjectiveQuery()
is false
optional
- This method must be implemented if
supportsLearningObjectiveQuery()
is true.
void matchAnyLearningObjective(boolean match)
match
- true
to match items with any learning
objective, false
to match items with no
learning objectivesmandatory
- This method must be implemented. void clearLearningObjectiveTerms()
mandatory
- This method must be implemented. void matchQuestionId(Id questionId, boolean match)
Id
for this query.questionId
- a question Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- questionId
is
null
mandatory
- This method must be implemented. void clearQuestionIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsQuestionQuery()
QuestionQuery
is available. true
if a question query is available,
false
otherwisemandatory
- This method must be implemented. QuestionQuery getQuestionQuery()
OR
term.UnimplementedException
- supportsQuestionQuery()
is false
optional
- This method must be implemented if
supportsLearningObjectiveQuery()
is true.
void matchAnyQuestion(boolean match)
match
- true
to match items with any question,
false
to match items with no questionsmandatory
- This method must be implemented. void clearQuestionTerms()
mandatory
- This method must be implemented. void matchAnswerId(Id answerId, boolean match)
Id
for this query.answerId
- an answer Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- answerId
is
null
mandatory
- This method must be implemented. void clearAnswerIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAnswerQuery()
AnswerQuery
is available. true
if an answer query is available,
false
otherwisemandatory
- This method must be implemented. AnswerQuery getAnswerQuery()
OR
term.UnimplementedException
- supportsAnswerQuery()
is false
optional
- This method must be implemented if
supportsLearningObjectiveQuery()
is true.
void matchAnyAnswer(boolean match)
match
- true
to match items with any answer,
false
to match items with no answersmandatory
- This method must be implemented. void clearAnswerTerms()
mandatory
- This method must be implemented. void matchAssessmentId(Id assessmentId, boolean match)
Id
for this query.assessmentId
- an assessment Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- assessmentId
is
null
mandatory
- This method must be implemented. void clearAssessmentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAssessmentQuery()
AssessmentQuery
is available. true
if an assessment query is available,
false
otherwisemandatory
- This method must be implemented. AssessmentQuery getAssessmentQuery()
OR
term.UnimplementedException
-
supportsAssessmentQuery()
is false
optional
- This method must be implemented if
supportsAssessmentQuery()
is true.
void matchAnyAssessment(boolean match)
match
- true
to match items with any assessment,
false
to match items with no assessmentsmandatory
- This method must be implemented. void clearAssessmentTerms()
mandatory
- This method must be implemented. void matchBankId(Id bankId, boolean match)
Id
for this query.bankId
- a bank Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- bankId
is
null
mandatory
- This method must be implemented. void clearBankIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBankQuery()
BankQuery
is available. true
if a bank query is available, false
otherwisemandatory
- This method must be implemented. BankQuery getBankQuery()
OR
term.UnimplementedException
- supportsBankQuery()
is false
optional
- This method must be implemented if
supportsBankQuery()
is true.
void clearBankTerms()
mandatory
- This method must be implemented. ItemQueryRecord getItemQueryRecord(Type itemRecordType) throws OperationFailedException
Item
record Type.
Multiple retrievals produce a
nested OR
term.itemRecordType
- an item record typeNullArgumentException
- itemRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(itemRecordType)
is false
mandatory
- This method must be implemented.