public interface SyllabusQuery extends OsidObjectQuery, OsidSubjugateableQuery
This is the query for searching syllaibi. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearCourseCatalogIdTerms()
Clears the course catalog
Id terms. |
void |
clearCourseCatalogTerms()
Clears the course catalog terms.
|
void |
clearCourseIdTerms()
Clears the course
Id terms. |
void |
clearCourseTerms()
Clears the course terms.
|
void |
clearModuleIdTerms()
Clears the module
Id terms. |
void |
clearModuleTerms()
Clears the module terms.
|
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog query.
|
CourseQuery |
getCourseQuery()
Gets the query for a course query.
|
ModuleQuery |
getModuleQuery()
Gets the query for a module query.
|
SyllabusQueryRecord |
getSyllabusQueryRecord(Type syllabusRecordType)
Gets the syllabus query record corresponding to the given
Syllabus record Type. |
void |
matchAnyModule(boolean match)
Matches any module.
|
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the docet
Id for this query to match syllabi
assigned to course catalogs. |
void |
matchCourseId(Id courseId,
boolean match)
Sets a course
Id. |
void |
matchModuleId(Id moduleId,
boolean match)
Sets a module
Id. |
boolean |
supportsCourseCatalogQuery()
Tests if an
CourseCatalogQuery is available. |
boolean |
supportsCourseQuery()
Tests if a
CourseQuery is available. |
boolean |
supportsModuleQuery()
Tests if a
ModuleQuery 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 matchCourseId(Id courseId, boolean match)
Id.
courseId
- a curse 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. 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 clearCourseTerms()
mandatory
- This method must be implemented. void matchModuleId(Id moduleId, boolean match)
Id.
moduleId
- a module Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- moduleId
is
null
mandatory
- This method must be implemented. void clearModuleIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsModuleQuery()
ModuleQuery
is available. true
if a module query is available,
false
otherwisemandatory
- This method must be implemented. ModuleQuery getModuleQuery()
OR
term.UnimplementedException
- supportsModuleQuery()
is false
optional
- This method must be implemented if
supportsModuleQuery()
is true.
void matchAnyModule(boolean match)
match
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearModuleTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query to match syllabi
assigned to course catalogs.courseCatalogId
- a 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. SyllabusQueryRecord getSyllabusQueryRecord(Type syllabusRecordType) throws OperationFailedException
Syllabus
record Type.
Multiple record
retrievals produce a nested OR
term.syllabusRecordType
- a syllabus record typeNullArgumentException
- syllabusRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(syllabusRecordType)
is false
mandatory
- This method must be implemented.