public interface PlanQuery extends OsidRelationshipQuery
This is the query for searching plans. 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 |
clearCourseOfferingIdTerms()
Clears the course offering
Id terms. |
void |
clearCourseOfferingTerms()
Clears the syllabus terms.
|
void |
clearLessonIdTerms()
Clears the lesson
Id terms. |
void |
clearLessonTerms()
Clears the lesson terms.
|
void |
clearModuleIdTerms()
Clears the module
Id terms. |
void |
clearModuleTerms()
Clears the module terms.
|
void |
clearSyllabusIdTerms()
Clears the syllabus
Id terms. |
void |
clearSyllabusTerms()
Clears the syllabus terms.
|
CourseCatalogQuery |
getCourseCatalogQuery()
Gets the query for a course catalog query.
|
CourseOfferingQuery |
getCourseOfferingQuery()
Gets the query for a course offering.
|
LessonQuery |
getLessonQuery()
Gets the query for a lesson query.
|
ModuleQuery |
getModuleQuery()
Gets the query for a module query.
|
PlanQueryRecord |
getPlanQueryRecord(Type planRecordType)
Gets the plan query record corresponding to the given
Plan
record Type. |
SyllabusQuery |
getSyllabusQuery()
Gets the query for a lesson.
|
void |
matchAnyLesson(boolean match)
Matches plans with any lesson.
|
void |
matchAnyModule(boolean match)
Matches plans with any module.
|
void |
matchCourseCatalogId(Id courseCatalogId,
boolean match)
Sets the lesson
Id for this query to match plans
assigned to course catalogs. |
void |
matchCourseOfferingId(Id courseOfferingId,
boolean match)
Sets the course offering
Id for this query. |
void |
matchLessonId(Id lessonId,
boolean match)
Sets a lesson
Id. |
void |
matchModuleId(Id moduleId,
boolean match)
Sets a module
Id. |
void |
matchSyllabusId(Id syllabusId,
boolean match)
Sets the syllabus
Id for this query. |
boolean |
supportsCourseCatalogQuery()
Tests if an
CourseCatalogQuery is available. |
boolean |
supportsCourseOfferingQuery()
Tests if a course offering query is available.
|
boolean |
supportsLessonQuery()
Tests if an
LessonQuery is available. |
boolean |
supportsSyllabusQuery()
Tests if a syllabus query is available.
|
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchSyllabusId(Id syllabusId, boolean match)
Id
for this query.syllabusId
- a syllabus Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- syllabusId
is
null
mandatory
- This method must be implemented. void clearSyllabusIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSyllabusQuery()
true
if a syllabus query is available,
false
otherwisemandatory
- This method must be implemented. SyllabusQuery getSyllabusQuery()
UnimplementedException
- supportsSyllabusQuery()
is false
optional
- This method must be implemented if
supportsSyllabusQuery()
is true.
void clearSyllabusTerms()
mandatory
- This method must be implemented. void matchCourseOfferingId(Id courseOfferingId, boolean match)
Id
for this query.courseOfferingId
- a course offering Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- syllabusId
is
null
mandatory
- This method must be implemented. void clearCourseOfferingIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCourseOfferingQuery()
true
if a course offering query is available,
false
otherwisemandatory
- This method must be implemented. CourseOfferingQuery getCourseOfferingQuery()
UnimplementedException
-
supportsCourseOfferingQuery()
is false
optional
- This method must be implemented if
supportsCourseOfferingQuery()
is true.
void clearCourseOfferingTerms()
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. ModuleQuery getModuleQuery()
OR
term.UnimplementedException
- supportsModuleQuery()
is false
optional
- This method must be implemented if
supportsModuleQuery()
is true.
void matchAnyModule(boolean match)
match
- true
to match pans with any module,
false
to match plans with no modulesmandatory
- This method must be implemented. void clearModuleTerms()
mandatory
- This method must be implemented. void matchLessonId(Id lessonId, boolean match)
Id.
lessonId
- a lesson Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- lessonId
is
null
mandatory
- This method must be implemented. void clearLessonIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsLessonQuery()
LessonQuery
is available. true
if a lesson query is available,
false
otherwisemandatory
- This method must be implemented. LessonQuery getLessonQuery()
OR
term.UnimplementedException
- supportsLessonQuery()
is false
optional
- This method must be implemented if
supportsLessonrQuery()
is true.
void matchAnyLesson(boolean match)
match
- true
to match covocations with any
lesson, false
to match plans with no lessonsmandatory
- This method must be implemented. void clearLessonTerms()
mandatory
- This method must be implemented. void matchCourseCatalogId(Id courseCatalogId, boolean match)
Id
for this query to match plans
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. PlanQueryRecord getPlanQueryRecord(Type planRecordType) throws OperationFailedException
Plan
record Type.
Multiple record retrievals produce
a nested OR
term.planRecordType
- a plan record typeNullArgumentException
- planRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(planRecordType)
is false
mandatory
- This method must be implemented.