Interface SyllabusQueryInspector

All Superinterfaces:

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

public interface SyllabusQueryInspector
extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector

The inspector for examining syllabus queries.

Method Summary

Modifier and Type	Method	Description
IdTerm[]	getCourseCatalogIdTerms()	Gets the course catalog Id terms.
CourseCatalogQueryInspector[]	getCourseCatalogTerms()	Gets the course catalog terms.
IdTerm[]	getCourseIdTerms()	Gets the course Id terms.
CourseQueryInspector[]	getCourseTerms()	Gets the course terms.
IdTerm[]	getModuleIdTerms()	Gets the module Id terms.
ModuleQueryInspector[]	getModuleTerms()	Gets the module terms.
SyllabusQueryInspectorRecord	getSyllabusQueryInspectorRecord(Type syllabusRecordType)	Gets the syllabus query inspector record corresponding to the given Syllabus record Type .

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

getCourseIdTerms

IdTerm[] getCourseIdTerms()

Gets the course Id terms.

Returns:

the course Id terms

Compliance:

mandatory - This method must be implemented.

getCourseTerms

CourseQueryInspector[] getCourseTerms()

Gets the course terms.

Returns:

the course terms

Compliance:

mandatory - This method must be implemented.

getModuleIdTerms

IdTerm[] getModuleIdTerms()

Gets the module Id terms.

Returns:

the module Id terms

Compliance:

mandatory - This method must be implemented.

getModuleTerms

ModuleQueryInspector[] getModuleTerms()

Gets the module terms.

Returns:

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

getSyllabusQueryInspectorRecord

SyllabusQueryInspectorRecord getSyllabusQueryInspectorRecord(Type syllabusRecordType)
                                                      throws OperationFailedException

Gets the syllabus query inspector record corresponding to the given Syllabus record Type .

Parameters:

syllabusRecordType - a syllabus record type

Returns:

the syllabus query inspector record

Throws:

NullArgumentException - syllabusRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(syllabusRecordType) is false

Compliance:

mandatory - This method must be implemented.