Interface ModuleQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector

public interface ModuleQueryInspector
extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector

The inspector for examining module queries.

Method Summary

Modifier and Type	Method	Description
IdTerm[]	getCourseCatalogIdTerms()	Gets the course catalog Id terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms()	Gets the course catalog terms.
IdTerm[]	getDocetIdTerms()	Gets the docet Id terms.
DocetQueryInspector[]	getDocetTerms()	Gets the docet terms.
ModuleQueryInspectorRecord	getModuleQueryInspectorRecord(Type moduleRecordType)	Gets the module query inspector record corresponding to the given Module record Type .
IdTerm[]	getSyllabusIdTerms()	Gets the syllabus Id terms.
SyllabusQueryInspector[]	getSyllabusTerms()	Gets the syllabus terms.

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 OsidExtensibleQueryInspector

getRecordTypeTerms

Modifier and Type	Method	Description
TypeTerm[]	getRecordTypeTerms()	Gets the record type query terms.

Methods inherited from interface OsidIdentifiableQueryInspector

getIdTerms

Modifier and Type	Method	Description
IdTerm[]	getIdTerms()	Gets the Id query terms.

Methods inherited from interface OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Modifier and Type	Method	Description
IdTerm[]	getCommentIdTerms()	Gets the comment Id query terms.
CommentQueryInspector[]	getCommentTerms()	Gets the comment query terms.
IdTerm[]	getCreditIdTerms()	Gets the credit Id query terms.
CreditQueryInspector[]	getCreditTerms()	Gets the credit query terms.
StringTerm[]	getDescriptionTerms()	Gets the description query terms.
StringTerm[]	getDisplayNameTerms()	Gets the display name query terms.
TypeTerm[]	getGenusTypeTerms()	Gets the genus type query terms.
IdTerm[]	getJournalEntryIdTerms()	Gets the journal entry Id query terms.
JournalEntryQueryInspector[]	getJournalEntryTerms()	Gets the journal entry query terms.
TypeTerm[]	getParentGenusTypeTerms()	Gets the parent genus type query terms.
IdTerm[]	getRelationshipIdTerms()	Gets the relationship Id query terms.
IdTerm[]	getRelationshipPeerIdTerms()	Gets the relationship peer Id query terms.
RelationshipQueryInspector[]	getRelationshipTerms()	Gets the relationship query terms.
IdTerm[]	getStateIdTerms()	Gets the state Id query terms.
StateQueryInspector[]	getStateTerms()	Gets the state query terms.
StatisticQueryInspector[]	getStatisticTerms()	Gets the statistic query terms.
IdTerm[]	getSubjectIdTerms()	Gets the subject Id query terms.
RelevancyQueryInspector[]	getSubjectRelevancyTerms()	Gets the subject relevancy query terms.
SubjectQueryInspector[]	getSubjectTerms()	Gets the subject query terms.

Methods inherited from interface OsidQueryInspector

getAnyTerms, getKeywordTerms

Modifier and Type	Method	Description
BooleanTerm[]	getAnyTerms()	Gets the any query terms.
StringTerm[]	getKeywordTerms()	Gets the keyword query terms.

Method Details

getSyllabusIdTerms

IdTerm[] getSyllabusIdTerms()

Gets the syllabus Id terms.

Returns:

the syllabus Id terms

Compliance:

mandatory - This method must be implemented.

getSyllabusTerms

SyllabusQueryInspector[] getSyllabusTerms()

Gets the syllabus terms.

Returns:

the syllabus terms

Compliance:

mandatory - This method must be implemented.

getDocetIdTerms

IdTerm[] getDocetIdTerms()

Gets the docet Id terms.

Returns:

the docet Id terms

Compliance:

mandatory - This method must be implemented.

getDocetTerms

DocetQueryInspector[] getDocetTerms()

Gets the docet terms.

Returns:

the docet terms

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdTerms

IdTerm[] getCourseCatalogIdTerms()

Gets the course catalog Id terms.

Returns:

the course catalog Id terms

Compliance:

mandatory - This method must be implemented.

getCourseCatalogTerms

CourseCatalogQueryInspector[] getCourseCatalogTerms()

Gets the course catalog terms.

Returns:

the course catalog terms

Compliance:

mandatory - This method must be implemented.

getModuleQueryInspectorRecord

ModuleQueryInspectorRecord getModuleQueryInspectorRecord(Type moduleRecordType)
                                                  throws OperationFailedException

Gets the module query inspector record corresponding to the given Module record Type .

Parameters:

moduleRecordType - a module record type

Returns:

the module query inspector record

Throws:

NullArgumentException - moduleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(moduleRecordType) is false

Compliance:

mandatory - This method must be implemented.