public interface CourseQuery extends OsidObjectQuery, OsidOperableQuery
This is the query for searching courses. 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 |
clearActivityUnitIdTerms()
Clears the activity unit
Id terms. |
void |
clearActivityUnitTerms()
Clears the activity unit 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 |
clearCreditAmountIdTerms()
Clears the grade system
Id terms. |
void |
clearCreditAmountTerms()
Clears the credit terms.
|
void |
clearGradingOptionIdTerms()
Clears the grade system
Id terms. |
void |
clearGradingOptionTerms()
Clears the grading option terms.
|
void |
clearLearningObjectiveIdTerms()
Clears the objective
Id terms. |
void |
clearLearningObjectiveTerms()
Clears the learning objective terms.
|
void |
clearLevelIdTerms()
Clears the grade
Id terms. |
void |
clearLevelTerms()
Clears the level terms.
|
void |
clearNumberTerms()
Clears the number terms.
|
void |
clearPrerequisitesIdTerms()
Clears the requisite
Id terms. |
void |
clearPrerequisitesInfoTerms()
Clears the prerequisite info terms.
|
void |
clearPrerequisitesTerms()
Clears the prerequisites terms.
|
void |
clearSponsorIdTerms()
Clears the sponsor
Id terms. |
void |
clearSponsorTerms()
Clears the sponsor terms.
|
void |
clearTitleTerms()
Clears the title terms.
|
ActivityUnitQuery |
getActivityUnitQuery()
Gets the query for an activity unit.
|
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog.
|
CourseOfferingQuery |
getCourseOfferingQuery()
Gets the query for a course offering.
|
CourseQueryRecord |
getCourseQueryRecord(Type courseRecordType)
Gets the course query record corresponding to the given
Course
record Type. |
GradeQuery |
getCreditAmountQuery()
Gets the query for a credit amount.
|
GradeSystemQuery |
getGradingOptionQuery()
Gets the query for a grading option.
|
ObjectiveQuery |
getLearningObjectiveQuery()
Gets the query for a learning objective.
|
GradeQuery |
getLevelQuery()
Gets the query for a grade level.
|
RequisiteQuery |
getPrerequisitesQuery()
Gets the query for a requisite.
|
ResourceQuery |
getSponsorQuery()
Gets the query for a sponsor.
|
void |
matchActivityUnitId(Id courseOfferingId,
boolean match)
Sets the course offering
Id for this query to match
courses that have a related course offering. |
void |
matchAnyActivityUnit(boolean match)
Matches courses that have any course offering.
|
void |
matchAnyCourseOffering(boolean match)
Matches courses that have any course offering.
|
void |
matchAnyCreditAmount(boolean match)
Matches courses that have any credits.
|
void |
matchAnyGradingOption(boolean match)
Matches courses that have any grading option.
|
void |
matchAnyLearningObjective(boolean match)
Matches courses that have any learning objective.
|
void |
matchAnyLevel(boolean match)
Matches courses that have any grade level.
|
void |
matchAnyNumber(boolean match)
Matches a course number that has any value.
|
void |
matchAnyPrerequisites(boolean match)
Matches courses that have any prerequisites.
|
void |
matchAnyPrerequisitesInfo(boolean match)
Matches a course that has any prerequisite information assigned.
|
void |
matchAnySponsor(boolean match)
Matches courses that have any sponsor.
|
void |
matchAnyTitle(boolean match)
Matches a title that has any value.
|
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the course catalog
Id for this query to match
courses assigned to course catalogs. |
void |
matchCourseOfferingId(Id courseOfferingId,
boolean match)
Sets the course offering
Id for this query to match
courses that have a related course offering. |
void |
matchCreditAmountId(Id gradeId,
boolean match)
Sets the grade
Id for this query to match courses with
a credit amount. |
void |
matchGradingOptionId(Id gradeSystemId,
boolean match)
Sets the grade system
Id for this query. |
void |
matchLearningObjectiveId(Id objectiveId,
boolean match)
Sets the objective
Id for this query. |
void |
matchLevelId(Id gradeId,
boolean match)
Sets the grade
Id for this query. |
void |
matchNumber(java.lang.String number,
Type stringMatchType,
boolean match)
Adds a course number for this query.
|
void |
matchPrerequisitesId(Id requisiteId,
boolean match)
Sets the requisite
Id for this query. |
void |
matchPrerequisitesInfo(java.lang.String prereqInfo,
Type stringMatchType,
boolean match)
Matches courses with the prerequisites informational string.
|
void |
matchSponsorId(Id resourceId,
boolean match)
Sets the resource
Id for this query to match courses
that have a sponsor. |
void |
matchTitle(java.lang.String title,
Type stringMatchType,
boolean match)
Adds a title for this query.
|
boolean |
supportsActivityUnitQuery()
Tests if a
ActivityUnitQuery is available. |
boolean |
supportsCourseCatalogQuery()
Tests if a
CourseCatalogQuery is available. |
boolean |
supportsCourseOfferingQuery()
Tests if a
CourseOfferingQuery is available. |
boolean |
supportsCreditAmountQuery()
Tests if a
GradeQuery is available. |
boolean |
supportsGradingOptionQuery()
Tests if a
GradeSystemQuery is available. |
boolean |
supportsLearningObjectiveQuery()
Tests if a
ObjectiveQuery is available. |
boolean |
supportsLevelQuery()
Tests if a
GradeQuery is available. |
boolean |
supportsPrerequisitesQuery()
Tests if a
RequisiteQuery is available. |
boolean |
supportsSponsorQuery()
Tests if a
ResourceQuery 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
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
void matchTitle(java.lang.String title, Type stringMatchType, boolean match)
title
- title string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- title
not of
stringMatchType
NullArgumentException
- title
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyTitle(boolean match)
match
- true
to match courses with any title,
false
to match courses with no titlemandatory
- This method must be implemented. void clearTitleTerms()
mandatory
- This method must be implemented. void matchNumber(java.lang.String number, Type stringMatchType, boolean match)
number
- course number string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- number
not of
stringMatchType
NullArgumentException
- number
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyNumber(boolean match)
match
- true
to match courses with any number,
false
to match courses with no titlemandatory
- This method must be implemented. void clearNumberTerms()
mandatory
- This method must be implemented. void matchSponsorId(Id resourceId, boolean match)
Id
for this query to match courses
that have a sponsor.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearSponsorIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSponsorQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getSponsorQuery()
OR
term.UnimplementedException
- supportsSponsorQuery()
is false
optional
- This method must be implemented if
supportsSponsorQuery()
is true.
void matchAnySponsor(boolean match)
match
- true
to match courses with any sponsor,
false
to match courses with no sponsorsmandatory
- This method must be implemented. void clearSponsorTerms()
mandatory
- This method must be implemented. void matchCreditAmountId(Id gradeId, boolean match)
Id
for this query to match courses with
a credit amount.gradeId
- a grade Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- gradeId
is
null
mandatory
- This method must be implemented. void clearCreditAmountIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCreditAmountQuery()
GradeQuery
is available. true
if a grade system query is available,
false
otherwisemandatory
- This method must be implemented. GradeQuery getCreditAmountQuery()
OR
term.UnimplementedException
- supportsCreditQuery()
is false
optional
- This method must be implemented if
supportsCreditQuery()
is true.
void matchAnyCreditAmount(boolean match)
match
- true
to match courses with any credits
false
to match courses with no creditsmandatory
- This method must be implemented. void clearCreditAmountTerms()
mandatory
- This method must be implemented. void matchPrerequisitesInfo(java.lang.String prereqInfo, Type stringMatchType, boolean match)
prereqInfo
- prerequisite informational string to matchstringMatchType
- the string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- prereqInfo
not of stringMatchType
NullArgumentException
- prereqInfo
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyPrerequisitesInfo(boolean match)
match
- true
to match courses with any
prerequisite information, false
otherwisemandatory
- This method must be implemented. void clearPrerequisitesInfoTerms()
mandatory
- This method must be implemented. void matchPrerequisitesId(Id requisiteId, boolean match)
Id
for this query.requisiteId
- a requisite Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- requisiteId
is
null
mandatory
- This method must be implemented. void clearPrerequisitesIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsPrerequisitesQuery()
RequisiteQuery
is available. true
if a requisite query is available,
false
otherwisemandatory
- This method must be implemented. RequisiteQuery getPrerequisitesQuery()
OR
term.UnimplementedException
-
supportsPrerequisitesQuery()
is false
optional
- This method must be implemented if
supportsPrerequisitesQuery()
is true.
void matchAnyPrerequisites(boolean match)
match
- true
to match courses with any
prerequisites, false
to match courses with no
prerequisitesmandatory
- This method must be implemented. void clearPrerequisitesTerms()
mandatory
- This method must be implemented. void matchLevelId(Id gradeId, boolean match)
Id
for this query.gradeId
- a grade Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- gradeId
is
null
mandatory
- This method must be implemented. void clearLevelIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsLevelQuery()
GradeQuery
is available. true
if a grade query is available,
false
otherwisemandatory
- This method must be implemented. GradeQuery getLevelQuery()
OR
term.UnimplementedException
- supportsLevelQuery()
is false
optional
- This method must be implemented if
supportsLevelQuery()
is true.
void matchAnyLevel(boolean match)
match
- true
to match courses with any level,
false
to match courses with no levelmandatory
- This method must be implemented. void clearLevelTerms()
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 courses with any grading
option, false
to match courses with no grading
optionsmandatory
- This method must be implemented. void clearGradingOptionTerms()
mandatory
- This method must be implemented. void matchLearningObjectiveId(Id objectiveId, boolean match)
Id
for this query.objectiveId
- an objective Id
match
- true
if a positive match, false
for a 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 an 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 courses with any learning
objective, false
to match courses with no
learning objectivesmandatory
- This method must be implemented. void clearLearningObjectiveTerms()
mandatory
- This method must be implemented. void matchActivityUnitId(Id courseOfferingId, boolean match)
Id
for this query to match
courses that have a related course offering.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 clearActivityUnitIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsActivityUnitQuery()
ActivityUnitQuery
is available. true
if a activity unit query is available,
false
otherwisemandatory
- This method must be implemented. ActivityUnitQuery getActivityUnitQuery()
OR
term.UnimplementedException
-
supportsActivityUnitQuery()
is false
optional
- This method must be implemented if
supportsActivityUnitQuery()
is true.
void matchAnyActivityUnit(boolean match)
match
- true
to match courses with any related
activity unit, false
to match courses with no
activity unitsmandatory
- This method must be implemented. void clearActivityUnitTerms()
mandatory
- This method must be implemented. void matchCourseOfferingId(Id courseOfferingId, boolean match)
Id
for this query to match
courses that have a related course offering.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 matchAnyCourseOffering(boolean match)
match
- true
to match courses with any course
offering, false
to match courses with no course
offeringmandatory
- This method must be implemented. void clearCourseOfferingTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query to match
courses 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. CourseQueryRecord getCourseQueryRecord(Type courseRecordType) throws OperationFailedException
Course
record Type.
Multiple record retrievals produce
a nested OR
term.courseRecordType
- a course record typeNullArgumentException
- courseRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseRecordType)
is false
mandatory
- This method must be implemented.