public interface ActivityQuery extends OsidObjectQuery, OsidSubjugateableQuery
This is the query for searching activities. 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 |
clearAssessmentIdTerms()
Clears the assessment
Id terms. |
void |
clearAssessmentTerms()
Clears the assessment terms.
|
void |
clearAssetIdTerms()
Clears the asset
Id terms. |
void |
clearAssetTerms()
Clears the asset terms.
|
void |
clearCourseIdTerms()
Clears the course
Id terms. |
void |
clearCourseTerms()
Clears the course terms.
|
void |
clearObjectiveBankIdTerms()
Clears the objective bank
Id terms. |
void |
clearObjectiveBankTerms()
Clears the objective bank terms.
|
void |
clearObjectiveIdTerms()
Clears the objective
Id terms. |
void |
clearObjectiveTerms()
Clears the objective terms.
|
ActivityQueryRecord |
getActivityQueryRecord(Type activityRecordType)
Gets the activity query record corresponding to the given
Activity record Type. |
AssessmentQuery |
getAssessmentQuery()
Gets the query for a assessment.
|
AssetQuery |
getAssetQuery()
Gets the query for an asset.
|
CourseQuery |
getCourseQuery()
Gets the query for a course.
|
ObjectiveBankQuery |
getObjectiveBankQuery()
Gets the query for an objective bank.
|
ObjectiveQuery |
getObjectiveQuery()
Gets the query for an objective.
|
void |
matchAnyAssessment(boolean match)
Matches an activity that has any assessment assigned.
|
void |
matchAnyAsset(boolean match)
Matches an activity that has any objective assigned.
|
void |
matchAnyCourse(boolean match)
Matches an activity that has any course assigned.
|
void |
matchAssessmentId(Id assessmentId,
boolean match)
Sets the assessment
Id for this query. |
void |
matchAssetId(Id assetId,
boolean match)
Sets the asset
Id for this query. |
void |
matchCourseId(Id courseId,
boolean match)
Sets the course
Id for this query. |
void |
matchObjectiveBankId(Id objectiveBankId,
boolean match)
Sets the objective bank
Id for this query. |
void |
matchObjectiveId(Id objectiveId,
boolean match)
Sets the objective
Id for this query. |
boolean |
supportsAssessmentQuery()
Tests if an
AssessmentQuery is available for querying
assessments. |
boolean |
supportsAssetQuery()
Tests if an
AssetQuery is available for querying
objectives. |
boolean |
supportsCourseQuery()
Tests if a
CourseQuery is available for querying
courses. |
boolean |
supportsObjectiveBankQuery()
Tests if a
ObjectiveBankQuery is available for querying
resources. |
boolean |
supportsObjectiveQuery()
Tests if an
ObjectiveQuery is available for querying
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, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchObjectiveId(Id objectiveId, boolean match)
Id
for this query.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 clearObjectiveIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsObjectiveQuery()
ObjectiveQuery
is available for querying
objectives. true
if an objective query is available,
false
otherwisemandatory
- This method must be implemented. ObjectiveQuery getObjectiveQuery()
OR
term.UnimplementedException
-
supportsObjectiveQuery()
is false
optional
- This method must be implemented if
supportsObjectiveQuery()
is true.
void clearObjectiveTerms()
mandatory
- This method must be implemented. void matchAssetId(Id assetId, boolean match)
Id
for this query.assetId
- an asset Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- assetId
is
null
mandatory
- This method must be implemented. void clearAssetIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAssetQuery()
AssetQuery
is available for querying
objectives. true
if an robjective query is available,
false
otherwisemandatory
- This method must be implemented. AssetQuery getAssetQuery()
OR
term.UnimplementedException
- supportsAssetQuery()
is false
optional
- This method must be implemented if
supportsObjectiveQuery()
is true.
void matchAnyAsset(boolean match)
match
- true
to match activities with any asset,
false
to match activities with no assetmandatory
- This method must be implemented. void clearAssetTerms()
mandatory
- This method must be implemented. void matchCourseId(Id courseId, boolean match)
Id
for this query.courseId
- a course Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- courseId
is
null
mandatory
- This method must be implemented. void clearCourseIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCourseQuery()
CourseQuery
is available for querying
courses. true
if a course query is available,
false
otherwisemandatory
- This method must be implemented. CourseQuery getCourseQuery()
OR
term.UnimplementedException
- supportsCourseQuery()
is false
optional
- This method must be implemented if
supportsCourseQuery()
is true.
void matchAnyCourse(boolean match)
match
- true
to match activities with any
courses, false
to match activities with no
coursesmandatory
- This method must be implemented. void clearCourseTerms()
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 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
assessments. 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 activities with any
assessments, false
to match activities with no
assessmentsmandatory
- This method must be implemented. void clearAssessmentTerms()
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
resources. 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. ActivityQueryRecord getActivityQueryRecord(Type activityRecordType) throws OperationFailedException
Activity
record Type.
Multiple retrievals
produce a nested OR
term.activityRecordType
- an activity query record typeNullArgumentException
- activityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityRecordType)
is false
mandatory
- This method must be implemented.