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

Modifier and Type	Method	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 .Multiple record retrievals produce a nested OR term.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

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 {@code supportsSyllabusQuery()} is {@code 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 {@code supportsCourseOfferingQuery()} is {@code 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 {@code supportsModuleQuery()} is {@code 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 {@code supportsLessonrQuery()} is {@code 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 {@code supportsCourseCatalogQuery()} is {@code 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.