org.osid.course.syllabus

Interface ModuleQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, OsidSubjugateableQuery, Suppliable

public interface ModuleQuery
extends OsidGovernatorQuery, OsidSubjugateableQuery

This is the query for searching modules. 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	clearDocetIdTerms() Clears the docet Id terms.
void	clearDocetTerms() Clears the docet terms.
void	clearSyllabusIdTerms() Clears the syllabus Id terms.
void	clearSyllabusTerms() Clears the syllabus terms.
CourseCatalogQuery	getCourseCatalogQuery() Gets the query for a course catalog query.
DocetQuery	getDocetQuery() Gets the query for a docet query.
ModuleQueryRecord	getModuleQueryRecord(Type moduleRecordType) Gets the module query record corresponding to the given Module record Type.
SyllabusQuery	getSyllabusQuery() Gets the query for a docet.
void	matchAnyDocet(boolean match) Matches modules with any docet.
void	matchCourseCatalogId(Id courseCatalogId, boolean match) Sets the docet Id for this query to match modules assigned to course catalogs.
void	matchDocetId(Id docetId, boolean match) Sets a docet Id.
void	matchSyllabusId(Id syllabusId, boolean match) Sets the syllabus Id for this query.
boolean	supportsCourseCatalogQuery() Tests if an CourseCatalogQuery is available.
boolean	supportsDocetQuery() Tests if an DocetQuery is available.
boolean	supportsSyllabusQuery() Tests if a syllabus query 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

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

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

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.

matchDocetId

void matchDocetId(Id docetId,
                boolean match)

Sets a docet Id.

Parameters:

docetId - a docet Id

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

Throws:

NullArgumentException - docetId is null

Compliance:

mandatory - This method must be implemented.

clearDocetIdTerms

void clearDocetIdTerms()

Clears the docet Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDocetQuery

boolean supportsDocetQuery()

Tests if an DocetQuery is available.

Returns:

true if a docet query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDocetQuery

DocetQuery getDocetQuery()

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

Returns:

the docet query

Throws:

UnimplementedException - supportsDocetQuery() is false

Compliance:

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

matchAnyDocet

void matchAnyDocet(boolean match)

Matches modules with any docet.

Parameters:

match - true to match modules with any docet, false to match modules with no docets

Compliance:

mandatory - This method must be implemented.

clearDocetTerms

void clearDocetTerms()

Clears the docet terms.

Compliance:

mandatory - This method must be implemented.

matchCourseCatalogId

void matchCourseCatalogId(Id courseCatalogId,
                        boolean match)

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

getModuleQueryRecord

ModuleQueryRecord getModuleQueryRecord(Type moduleRecordType)
                                       throws OperationFailedException

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

Parameters:

moduleRecordType - a module record type

Returns:

the module query record

Throws:

NullArgumentException - moduleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(moduleRecordType) is false

Compliance:

mandatory - This method must be implemented.