public interface ActivityBundleQuery extends OsidObjectQuery
This is the query for searching activity bundles. Each method match
specifies an AND
term while multiple invocations of the
same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearActivityIdTerms()
Clears the activity
Id terms. |
void |
clearActivityTerms()
Clears the activity terms.
|
void |
clearCourseCatalogIdTerms()
Clears the course catalog
Id terms. |
void |
clearCourseCatalogTerms()
Clears the course catalog terms.
|
void |
clearCourseOfferingIdTerms()
Clears the course offering
Id terms. |
void |
clearCourseOfferingTerms()
Clears the course offering terms.
|
void |
clearCreditsTerms()
Clears the credit terms.
|
void |
clearGradingOptionIdTerms()
Clears the grade system
Id terms. |
void |
clearGradingOptionTerms()
Clears the grading option terms.
|
ActivityBundleQueryRecord |
getActivityBundleQueryRecord(Type activityBundleRecordType)
Gets the activity bundle query record corresponding to the given
Course record Type. |
ActivityQuery |
getActivityQuery()
Gets the query for an activity.
|
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog.
|
CourseOfferingQuery |
getCourseOfferingQuery()
Gets the query for a course offering.
|
GradeSystemQuery |
getGradingOptionQuery()
Gets the query for a grading option.
|
void |
matchActivityId(Id activityId,
boolean match)
Sets the activity
Id for this query to match activity
bundles that have a related course. |
void |
matchAnyActivity(boolean match)
Matches activity bundles that have any activity.
|
void |
matchAnyCredits(boolean match)
Matches an activity bundle that has any credits assigned.
|
void |
matchAnyGradingOption(boolean match)
Matches activity bundles that have any grading option.
|
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the course catalog
Id for this query to match
activity bundles assigned to course catalogs. |
void |
matchCourseOfferingId(Id courseOfferingId,
boolean match)
Sets the course offering
Id for this query. |
void |
matchCredits(java.math.BigDecimal min,
java.math.BigDecimal max,
boolean match)
Matches activity bundles with credits between the given numbers
inclusive.
|
void |
matchGradingOptionId(Id gradeSystemId,
boolean match)
Sets the grade system
Id for this query. |
boolean |
supportsActivityQuery()
Tests if an
ActivityQuery is available. |
boolean |
supportsCourseCatalogQuery()
Tests if a
CourseCatalogQuery is available. |
boolean |
supportsCourseOfferingQuery()
Tests if a
CourseOfferingQuery is available. |
boolean |
supportsGradingOptionQuery()
Tests if a
GradeSystemQuery 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 matchCourseOfferingId(Id courseOfferingId, boolean match)
Id
for this query.courseOfferingId
- a course offering Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- courseOfferingId
is null
mandatory
- This method must be implemented. void clearCourseOfferingIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCourseOfferingQuery()
CourseOfferingQuery
is available. true
if a course offering query is available,
false
otherwisemandatory
- This method must be implemented. CourseOfferingQuery getCourseOfferingQuery()
OR
term.UnimplementedException
-
supportsCourseOfferingQuery()
is false
optional
- This method must be implemented if
supportsCourseOfferingQuery()
is true.
void clearCourseOfferingTerms()
mandatory
- This method must be implemented. void matchActivityId(Id activityId, boolean match)
Id
for this query to match activity
bundles that have a related course.activityId
- an activity Id
match
- true
if 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. 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 activity bundles with any
activity, false
to match activity bundles with
no activitiesmandatory
- This method must be implemented. void clearActivityTerms()
mandatory
- This method must be implemented. void matchCredits(java.math.BigDecimal min, java.math.BigDecimal max, boolean match)
min
- low numbermax
- high numbermatch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- max
is less
than min
mandatory
- This method must be implemented. void matchAnyCredits(boolean match)
match
- true
to match activity bundles with any
credits, false
to match activity bundles with
no creditsmandatory
- This method must be implemented. void clearCreditsTerms()
mandatory
- This method must be implemented. void matchGradingOptionId(Id gradeSystemId, boolean match)
Id
for this query.gradeSystemId
- a grade system Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- gradeSystemId
is
null
mandatory
- This method must be implemented. void clearGradingOptionIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsGradingOptionQuery()
GradeSystemQuery
is available. true
if a grade system query is available,
false
otherwisemandatory
- This method must be implemented. GradeSystemQuery getGradingOptionQuery()
OR
term.UnimplementedException
-
supportsGradingOptionQuery()
is false
optional
- This method must be implemented if
supportsGradingOptionQuery()
is true.
void matchAnyGradingOption(boolean match)
match
- true
to match activity bundles with any
grading option, false
to match activity bundles
with no grading optionsmandatory
- This method must be implemented. void clearGradingOptionTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query to match
activity bundles assigned to course catalogs.courseCatalogId
- the course catalog Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- courseCatalogId
is null
mandatory
- This method must be implemented. void clearCourseCatalogIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCourseCatalogQuery()
CourseCatalogQuery
is available. true
if a course catalog query is available,
false
otherwisemandatory
- This method must be implemented. CourseCatalogQuery getCourseCatalogQuery()
OR
term.UnimplementedException
-
supportsCourseCatalogQuery()
is false
optional
- This method must be implemented if
supportsCourseCatalogQuery()
is true.
void clearCourseCatalogTerms()
mandatory
- This method must be implemented. ActivityBundleQueryRecord getActivityBundleQueryRecord(Type activityBundleRecordType) throws OperationFailedException
Course
record Type.
Multiple record
retrievals produce a nested OR
term.activityBundleRecordType
- an activity bundle record typeNullArgumentException
- activityBundleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(activityBundleRecordType)
is
false
mandatory
- This method must be implemented.