org.osid.course.plan

Interface PlanQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.OsidObjectQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchSyllabusId

void matchSyllabusId(Id syllabusId,
                   boolean match)

Sets the syllabus Id for this query.

Parameters:

syllabusId - a syllabus Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - syllabusId is null

Compliance:

mandatory - This method must be implemented.

clearSyllabusIdTerms

void clearSyllabusIdTerms()

Clears the syllabus Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSyllabusQuery

boolean supportsSyllabusQuery()

Tests if a syllabus query is available.

Returns:

true if a syllabus query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSyllabusQuery

SyllabusQuery getSyllabusQuery()

Gets the query for a lesson.

Returns:

the syllabus query

Throws:

UnimplementedException - supportsSyllabusQuery() is false

Compliance:

optional - This method must be implemented if supportsSyllabusQuery() is true.

clearSyllabusTerms

void clearSyllabusTerms()

Clears the syllabus terms.

Compliance:

mandatory - This method must be implemented.

matchCourseOfferingId

void matchCourseOfferingId(Id courseOfferingId,
                         boolean match)

Sets the course offering Id for this query.

Parameters:

courseOfferingId - a course offering Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - syllabusId is null

Compliance:

mandatory - This method must be implemented.

clearCourseOfferingIdTerms

void clearCourseOfferingIdTerms()

Clears the course offering Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCourseOfferingQuery

boolean supportsCourseOfferingQuery()

Tests if a course offering query is available.

Returns:

true if a course offering query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseOfferingQuery

CourseOfferingQuery getCourseOfferingQuery()

Gets the query for a course offering.

Returns:

the course offering query

Throws:

UnimplementedException - supportsCourseOfferingQuery() is false

Compliance:

optional - This method must be implemented if supportsCourseOfferingQuery() is true.

clearCourseOfferingTerms

void clearCourseOfferingTerms()

Clears the syllabus terms.

Compliance:

mandatory - This method must be implemented.

matchModuleId

void matchModuleId(Id moduleId,
                 boolean match)

Sets a module Id.

Parameters:

moduleId - a module Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - moduleId is null

Compliance:

mandatory - This method must be implemented.

clearModuleIdTerms

void clearModuleIdTerms()

Clears the module Id terms.

Compliance:

mandatory - This method must be implemented.

getModuleQuery

ModuleQuery getModuleQuery()

Gets the query for a module query. Multiple retrievals produce a nested OR term.

Returns:

the lesson query

Throws:

UnimplementedException - supportsModuleQuery() is false

Compliance:

optional - This method must be implemented if supportsModuleQuery() is true.

matchAnyModule

void matchAnyModule(boolean match)

Matches plans with any module.

Parameters:

match - true to match pans with any module, false to match plans with no modules

Compliance:

mandatory - This method must be implemented.

clearModuleTerms

void clearModuleTerms()

Clears the module terms.

Compliance:

mandatory - This method must be implemented.

matchLessonId

void matchLessonId(Id lessonId,
                 boolean match)

Sets a lesson Id.

Parameters:

lessonId - a lesson Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - lessonId is null

Compliance:

mandatory - This method must be implemented.

clearLessonIdTerms

void clearLessonIdTerms()

Clears the lesson Id terms.

Compliance:

mandatory - This method must be implemented.

supportsLessonQuery

boolean supportsLessonQuery()

Tests if an LessonQuery is available.

Returns:

true if a lesson query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLessonQuery

LessonQuery getLessonQuery()

Gets the query for a lesson query. Multiple retrievals produce a nested OR term.

Returns:

the lesson query

Throws:

UnimplementedException - supportsLessonQuery() is false

Compliance:

optional - This method must be implemented if supportsLessonrQuery() is true.

matchAnyLesson

void matchAnyLesson(boolean match)

Matches plans with any lesson.

Parameters:

match - true to match covocations with any lesson, false to match plans with no lessons

Compliance:

mandatory - This method must be implemented.

clearLessonTerms

void clearLessonTerms()

Clears the lesson terms.

Compliance:

mandatory - This method must be implemented.

matchCourseCatalogId

void matchCourseCatalogId(Id courseCatalogId,
                        boolean match)

Sets the lesson Id for this query to match plans assigned to course catalogs.

Parameters:

courseCatalogId - a course catalog Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - courseCatalogId is null

Compliance:

mandatory - This method must be implemented.

clearCourseCatalogIdTerms

void clearCourseCatalogIdTerms()

Clears the course catalog Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCourseCatalogQuery

boolean supportsCourseCatalogQuery()

Tests if an CourseCatalogQuery is available.

Returns:

true if a course catalog query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseCatalogQuery

CourseCatalogQuery getCourseCatalogQuery()

Gets the query for a course catalog query. Multiple retrievals produce a nested OR term.

Returns:

the course catalog query

Throws:

UnimplementedException - supportsCourseCatalogQuery() is false

Compliance:

optional - This method must be implemented if supportsCourseCatalogQuery() is true.

clearCourseCatalogTerms

void clearCourseCatalogTerms()

Clears the course catalog terms.

Compliance:

mandatory - This method must be implemented.

getPlanQueryRecord

PlanQueryRecord getPlanQueryRecord(Type planRecordType)
                                   throws OperationFailedException

Gets the plan query record corresponding to the given Plan record Type. Multiple record retrievals produce a nested OR term.

Parameters:

planRecordType - a plan record type

Returns:

the plan query record

Throws:

NullArgumentException - planRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(planRecordType) is false

Compliance:

mandatory - This method must be implemented.