Interface ModuleQuery

All Superinterfaces:

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

public interface ModuleQuery
extends OsidObjectQuery, 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

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

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

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.

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 {@code supportsDocetQuery()} is {@code 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 {@code supportsCourseCatalogQuery()} is {@code 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.