public interface ObjectiveQuery extends OsidObjectQuery, OsidFederateableQuery
This is the query for searching objectives. 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 |
clearActivityIdTerms()
Clears the activity
Id terms. |
void |
clearActivityTerms()
Clears the activity terms.
|
void |
clearAncestorObjectiveIdTerms()
Clears the ancestor objective
Id query terms. |
void |
clearAncestorObjectiveTerms()
Clears the ancestor objective query terms.
|
void |
clearAssessmentIdTerms()
Clears the assessment
Id terms. |
void |
clearAssessmentTerms()
Clears the assessment terms.
|
void |
clearCognitiveProcessIdTerms()
Clears the cognitive process
Id terms. |
void |
clearCognitiveProcessTerms()
Clears the cognitive process terms.
|
void |
clearDependentObjectiveIdTerms()
Clears the dependent objective
Id terms. |
void |
clearDependentObjectiveTerms()
Clears the dependent objective terms.
|
void |
clearDescendantObjectiveIdTerms()
Clears the descendant objective
Id query terms. |
void |
clearDescendantObjectiveTerms()
Clears the descendant objective query terms.
|
void |
clearEquivalentObjectiveIdTerms()
Clears the equivalent objective
Id terms. |
void |
clearEquivalentObjectiveTerms()
Clears the equivalent objective terms.
|
void |
clearKnowledgeCategoryIdTerms()
Clears the knowledge category
Id terms. |
void |
clearKnowledgeCategoryTerms()
Clears the knowledge category terms.
|
void |
clearObjectiveBankIdTerms()
Clears the objective bank
Id terms. |
void |
clearObjectiveBankTerms()
Clears the objective bank terms.
|
void |
clearRequisiteObjectiveIdTerms()
Clears the requisite objective
Id terms. |
void |
clearRequisiteObjectiveTerms()
Clears the requisite objective terms.
|
ActivityQuery |
getActivityQuery()
Gets the query for an activity.
|
ObjectiveQuery |
getAncestorObjectiveQuery()
Gets the query for an objective.
|
AssessmentQuery |
getAssessmentQuery()
Gets the query for an assessment.
|
GradeQuery |
getCognitiveProcessQuery()
Gets the query for a cognitive process.
|
ObjectiveQuery |
getDependentObjectiveQuery()
Gets the query for a dependent objective.
|
ObjectiveQuery |
getDescendantObjectiveQuery()
Gets the query for an objective.
|
ObjectiveQuery |
getEquivalentObjectiveQuery()
Gets the query for an equivalent objective.
|
GradeQuery |
getKnowledgeCategoryQuery()
Gets the query for a knowledge category.
|
ObjectiveBankQuery |
getObjectiveBankQuery()
Gets the query for an objective bank.
|
ObjectiveQueryRecord |
getObjectiveQueryRecord(Type objectiveRecordType)
Gets the objective query record corresponding to the given
Objective record Type. |
ObjectiveQuery |
getRequisiteObjectiveQuery()
Gets the query for a requisite objective.
|
void |
matchActivityId(Id activityId,
boolean match)
Sets the activity
Id for this query. |
void |
matchAncestorObjectiveId(Id objectiveId,
boolean match)
Sets the objective
Id for this query to match
objectives that have the specified objective as an ancestor. |
void |
matchAnyActivity(boolean match)
Matches an objective that has any related activity.
|
void |
matchAnyAncestorObjective(boolean match)
Matches objectives that have any ancestor.
|
void |
matchAnyAssessment(boolean match)
Matches an objective that has any assessment assigned.
|
void |
matchAnyCognitiveProcess(boolean match)
Matches an objective that has any cognitive process.
|
void |
matchAnyDependentObjective(boolean match)
Matches an objective that has any related dependents.
|
void |
matchAnyDescendantObjective(boolean match)
Matches objectives that have any ancestor.
|
void |
matchAnyEquivalentObjective(boolean match)
Matches an objective that has any related equivalents.
|
void |
matchAnyKnowledgeCategory(boolean match)
Matches an objective that has any knowledge category.
|
void |
matchAnyRequisiteObjective(boolean match)
Matches an objective that has any related requisite.
|
void |
matchAssessmentId(Id assessmentId,
boolean match)
Sets the assessment
Id for this query. |
void |
matchCognitiveProcessId(Id gradeId,
boolean match)
Sets the cognitive process
Id for this query. |
void |
matchDependentObjectiveId(Id dependentObjectiveId,
boolean match)
Sets the dependent objective
Id to query objectives
dependent on the given objective. |
void |
matchDescendantObjectiveId(Id objectiveId,
boolean match)
Sets the objective
Id for this query to match
objectives that have the specified objective as a descendant. |
void |
matchEquivalentObjectiveId(Id equivalentObjectiveId,
boolean match)
Sets the equivalent objective
Id to query equivalents. |
void |
matchKnowledgeCategoryId(Id gradeId,
boolean match)
Sets the knowledge category
Id for this query. |
void |
matchObjectiveBankId(Id objectiveBankId,
boolean match)
Sets the objective bank
Id for this query. |
void |
matchRequisiteObjectiveId(Id requisiteObjectiveId,
boolean match)
Sets the requisite objective
Id for this query. |
boolean |
supportsActivityQuery()
Tests if an
ActivityQuery is available for querying
activities. |
boolean |
supportsAncestorObjectiveQuery()
Tests if an
ObjectiveQuery is available. |
boolean |
supportsAssessmentQuery()
Tests if an
AssessmentQuery is available for querying
activities. |
boolean |
supportsCognitiveProcessQuery()
Tests if a
GradeQuery is available for querying
cognitive processes. |
boolean |
supportsDepndentObjectiveQuery()
Tests if an
ObjectiveQuery is available for querying
dependent objectives. |
boolean |
supportsDescendantObjectiveQuery()
Tests if an
ObjectiveQuery is available. |
boolean |
supportsEquivalentObjectiveQuery()
Tests if an
ObjectiveQuery is available for querying
equivalent objectives. |
boolean |
supportsKnowledgeCategoryQuery()
Tests if a
GradeQuery is available for querying
knowledge categories. |
boolean |
supportsObjectiveBankQuery()
Tests if a
ObjectiveBankQuery is available for querying
objective banks. |
boolean |
supportsRequisiteObjectiveQuery()
Tests if an
ObjectiveQuery is available for querying
requisite objectives. |
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, supportsSubjectRelevancyQueryclearIdTerms, matchIdclearRecordTerms, matchAnyRecord, matchRecordTypegetRecordTypes, hasRecordTypeclearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchTypevoid matchAssessmentId(Id assessmentId, boolean match)
Id for this query.assessmentId - an assessment Id match - true for a positive match, false
for a 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 for querying
activities. 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 objectives with any
assessment, false to match objectives with no
assessmentmandatory - This method must be implemented. void clearAssessmentTerms()
mandatory - This method must be implemented. void matchKnowledgeCategoryId(Id gradeId, boolean match)
Id for this query.gradeId - a grade Id match - true for a positive match, false
for a negative matchNullArgumentException - gradeId is
null mandatory - This method must be implemented. void clearKnowledgeCategoryIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsKnowledgeCategoryQuery()
GradeQuery is available for querying
knowledge categories. true if a grade query is available,
false otherwisemandatory - This method must be implemented. GradeQuery getKnowledgeCategoryQuery()
OR term.UnimplementedException -
supportsKnowledgeCategoryQuery() is false
optional - This method must be implemented if
supportsKnowledgeCategoryQuery() is true.
void matchAnyKnowledgeCategory(boolean match)
match - true to match objectives with any
knowledge category, false to match objectives
with no knowledge categorymandatory - This method must be implemented. void clearKnowledgeCategoryTerms()
mandatory - This method must be implemented. void matchCognitiveProcessId(Id gradeId, boolean match)
Id for this query.gradeId - a grade Id match - true for a positive match, false
for a negative matchNullArgumentException - gradeId is
null mandatory - This method must be implemented. void clearCognitiveProcessIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsCognitiveProcessQuery()
GradeQuery is available for querying
cognitive processes. true if a grade query is available,
false otherwisemandatory - This method must be implemented. GradeQuery getCognitiveProcessQuery()
OR term.UnimplementedException -
supportsCognitiveProcessQuery() is false
optional - This method must be implemented if
supportsCognitiveProcessQuery() is true.
void matchAnyCognitiveProcess(boolean match)
match - true to match objectives with any
cognitive process, false to match objectives
with no cognitive processmandatory - This method must be implemented. void clearCognitiveProcessTerms()
mandatory - This method must be implemented. void matchActivityId(Id activityId, boolean match)
Id for this query.activityId - an activity Id match - true for a positive match, false
for a negative matchNullArgumentException - activityId is
null mandatory - This method must be implemented. void clearActivityIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsActivityQuery()
ActivityQuery is available for querying
activities. true if an activity query is available,
false otherwisemandatory - This method must be implemented. ActivityQuery getActivityQuery()
OR term.UnimplementedException - supportsActivityQuery()
is false optional - This method must be implemented if
supportsActivityQuery() is true. void matchAnyActivity(boolean match)
match - true to match objectives with any
activity, false to match objectives with no
activitymandatory - This method must be implemented. void clearActivityTerms()
mandatory - This method must be implemented. void matchRequisiteObjectiveId(Id requisiteObjectiveId, boolean match)
Id for this query.requisiteObjectiveId - a requisite objective Id match - true for a positive match, false
for a negative matchNullArgumentException - requisiteObjectiveId
is null mandatory - This method must be implemented. void clearRequisiteObjectiveIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsRequisiteObjectiveQuery()
ObjectiveQuery is available for querying
requisite objectives. true if an objective query is available,
false otherwisemandatory - This method must be implemented. ObjectiveQuery getRequisiteObjectiveQuery()
OR term.UnimplementedException -
supportsRequisiteObjectiveQuery() is false
optional - This method must be implemented if
supportsRequisiteObjectiveQuery() is true.
void matchAnyRequisiteObjective(boolean match)
match - true to match objectives with any
requisite, false to match objectives with no
requisitemandatory - This method must be implemented. void clearRequisiteObjectiveTerms()
mandatory - This method must be implemented. void matchDependentObjectiveId(Id dependentObjectiveId, boolean match)
Id to query objectives
dependent on the given objective.dependentObjectiveId - a dependent objective Id match - true for a positive match, false
for a negative matchNullArgumentException - dependentObjectiveId
is null mandatory - This method must be implemented. void clearDependentObjectiveIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsDepndentObjectiveQuery()
ObjectiveQuery is available for querying
dependent objectives. true if an objective query is available,
false otherwisemandatory - This method must be implemented. ObjectiveQuery getDependentObjectiveQuery()
OR term.UnimplementedException -
supportsDependentObjectiveQuery() is false
optional - This method must be implemented if
supportsDependentQuery() is true. void matchAnyDependentObjective(boolean match)
match - true to match objectives with any
dependent, false to match objectives with no
dependentsmandatory - This method must be implemented. void clearDependentObjectiveTerms()
mandatory - This method must be implemented. void matchEquivalentObjectiveId(Id equivalentObjectiveId, boolean match)
Id to query equivalents.equivalentObjectiveId - an equivalent objective Id
match - true for a positive match, false
for a negative matchNullArgumentException - equivalentObjectiveId
is null mandatory - This method must be implemented. void clearEquivalentObjectiveIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsEquivalentObjectiveQuery()
ObjectiveQuery is available for querying
equivalent objectives. true if an objective query is available,
false otherwisemandatory - This method must be implemented. ObjectiveQuery getEquivalentObjectiveQuery()
OR term.UnimplementedException -
supportsEquivalentObjectiveQuery() is false
optional - This method must be implemented if
supportsEquivalentQuery() is true. void matchAnyEquivalentObjective(boolean match)
match - true to match objectives with any
equivalent, false to match objectives with no
equivalentsmandatory - This method must be implemented. void clearEquivalentObjectiveTerms()
mandatory - This method must be implemented. void matchAncestorObjectiveId(Id objectiveId, boolean match)
Id for this query to match
objectives that have the specified objective as an ancestor.objectiveId - an objective Id match - true for a positive match, false
for a negative matchNullArgumentException - objectiveId is
null mandatory - This method must be implemented. void clearAncestorObjectiveIdTerms()
Id query terms.mandatory - This method must be implemented. boolean supportsAncestorObjectiveQuery()
ObjectiveQuery is available. true if an objective query is available,
false otherwisemandatory - This method must be implemented. ObjectiveQuery getAncestorObjectiveQuery()
OR term.UnimplementedException -
supportsAncestorObjectiveQuery() is false
optional - This method must be implemented if
supportsAncestorObjectiveQuery() is true.
void matchAnyAncestorObjective(boolean match)
match - true to match objective with any
ancestor, false to match root objectivesmandatory - This method must be implemented. void clearAncestorObjectiveTerms()
mandatory - This method must be implemented. void matchDescendantObjectiveId(Id objectiveId, boolean match)
Id for this query to match
objectives that have the specified objective as a descendant.objectiveId - an objective Id match - true for a positive match, false
for a negative matchNullArgumentException - objectiveId is
null mandatory - This method must be implemented. void clearDescendantObjectiveIdTerms()
Id query terms.mandatory - This method must be implemented. boolean supportsDescendantObjectiveQuery()
ObjectiveQuery is available. true if an objective query is available,
false otherwisemandatory - This method must be implemented. ObjectiveQuery getDescendantObjectiveQuery()
OR term.UnimplementedException -
supportsDescendantObjectiveQuery() is false
optional - This method must be implemented if
supportsDescendantObjectiveQuery() is true.
void matchAnyDescendantObjective(boolean match)
match - true to match objectives with any
ancestor, false to match leaf objectivesmandatory - This method must be implemented. void clearDescendantObjectiveTerms()
mandatory - This method must be implemented. void matchObjectiveBankId(Id objectiveBankId, boolean match)
Id for this query.objectiveBankId - an objective bank Id match - true for a positive match, false
for a negative matchNullArgumentException - objectiveBankId
is null mandatory - This method must be implemented. void clearObjectiveBankIdTerms()
Id terms.mandatory - This method must be implemented. boolean supportsObjectiveBankQuery()
ObjectiveBankQuery is available for querying
objective banks. true if an objective bank query is available,
false otherwisemandatory - This method must be implemented. ObjectiveBankQuery getObjectiveBankQuery()
OR term.UnimplementedException -
supportsObjectiveBankQuery() is false optional - This method must be implemented if
supportsObjectiveBankQuery() is true.
void clearObjectiveBankTerms()
mandatory - This method must be implemented. ObjectiveQueryRecord getObjectiveQueryRecord(Type objectiveRecordType) throws OperationFailedException
Objective record Type. Multiple retrievals
produce a nested OR term.objectiveRecordType - an objective query record typeNullArgumentException - objectiveRecordType
is null OperationFailedException - unable to complete requestUnsupportedException -
hasRecordType(objectiveRecordType) is false
mandatory - This method must be implemented.