org.osid.course.syllabus

Interface SyllabusQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

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.

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	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.

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

Method Detail

matchCourseId

void matchCourseId(Id courseId,
                 boolean match)

Sets a course Id.

Parameters:

courseId - a curse Id

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

Throws:

NullArgumentException - courseId is null

Compliance:

mandatory - This method must be implemented.

clearCourseIdTerms

void clearCourseIdTerms()

Clears the course Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCourseQuery

boolean supportsCourseQuery()

Tests if a CourseQuery is available.

Returns:

true if a course query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCourseQuery

CourseQuery getCourseQuery()

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

Returns:

the course query

Throws:

UnimplementedException - supportsCourseQuery() is false

Compliance:

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

clearCourseTerms

void clearCourseTerms()

Clears the course 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.

supportsModuleQuery

boolean supportsModuleQuery()

Tests if a ModuleQuery is available.

Returns:

true if a module query is available, false otherwise

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 module query

Throws:

UnimplementedException - supportsModuleQuery() is false

Compliance:

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

matchAnyModule

void matchAnyModule(boolean match)

Matches any module.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearModuleTerms

void clearModuleTerms()

Clears the module terms.

Compliance:

mandatory - This method must be implemented.

matchCourseCatalogId

void matchCourseCatalogId(Id courseCatalogId,
                        boolean match)

Sets the docet Id for this query to match syllabi 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.

getSyllabusQueryRecord

SyllabusQueryRecord getSyllabusQueryRecord(Type syllabusRecordType)
                                           throws OperationFailedException

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

Parameters:

syllabusRecordType - a syllabus record type

Returns:

the syllabus query record

Throws:

NullArgumentException - syllabusRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(syllabusRecordType) is false

Compliance:

mandatory - This method must be implemented.