Interface ProgramOfferingQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
The query inspectors provide a means of accessing the match terms of a
query. These interfaces are used to examine the actual query terms used in
a search or that may be used to create a smart catalog. Query inspectors
may be converted to OsidQuery interfaces for reuse or modification
in the search sessions.
-
Method Summary
Modifier and TypeMethodDescriptionIdTerm[]Gets the completion requirements requisiteIdquery terms.Gets the completion requirements query terms.Gets the completion requirements requisite query terms.IdTerm[]Gets the course catalogIdquery terms.Gets the course catalog query terms.IdTerm[]Gets the credentialIdquery terms.Gets the credential query terms.IdTerm[]Gets the objectiveIdquery terms.Gets the objective query terms.Gets the maximum seats query terms.Gets the minimum seats query terms.Gets the bumber query terms.IdTerm[]Gets the parent program offeringIdquery terms.Gets the parent program offering query terms.IdTerm[]Gets the courseIdquery terms.getProgramOfferingQueryInspectorRecord(Type programOfferingRecordType) Gets the program offering query inspector record corresponding to the givenProgramOfferingrecordType.Gets the program query terms.Gets the requires registration query terms.IdTerm[]Gets the restricted audienceIdquery terms.Gets the restricted audience query terms.IdTerm[]Gets the sponsorIdquery terms.Gets the sponsor query terms.IdTerm[]Gets the termIdquery terms.Gets the term query terms.Gets the title query terms.Gets the url query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.Methods inherited from interface OsidRelationshipQueryInspector
getEndReasonIdTerms, getEndReasonTermsModifier and TypeMethodDescriptionIdTerm[]Gets the end reaosn stateIdquery terms.Gets the end reaosn state query terms.Methods inherited from interface OsidTemporalQueryInspector
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTermsModifier and TypeMethodDescriptionGets the date query terms.Gets the effective query terms.Gets the end date query terms.Gets the start date query terms.
-
Method Details
-
getProgramIdTerms
IdTerm[] getProgramIdTerms()Gets the courseIdquery terms.- Returns:
- the course
Idquery terms - Compliance:
mandatory- This method must be implemented.
-
getProgramTerms
ProgramQueryInspector[] getProgramTerms()Gets the program query terms.- Returns:
- the program query terms
- Compliance:
mandatory- This method must be implemented.
-
getTermIdTerms
IdTerm[] getTermIdTerms()Gets the termIdquery terms.- Returns:
- the term
Idquery terms - Compliance:
mandatory- This method must be implemented.
-
getTermTerms
TermQueryInspector[] getTermTerms()Gets the term query terms.- Returns:
- the term query terms
- Compliance:
mandatory- This method must be implemented.
-
getTitleTerms
StringTerm[] getTitleTerms()Gets the title query terms.- Returns:
- the title query terms
- Compliance:
mandatory- This method must be implemented.
-
getNumberTerms
StringTerm[] getNumberTerms()Gets the bumber query terms.- Returns:
- the number query terms
- Compliance:
mandatory- This method must be implemented.
-
getSponsorIdTerms
IdTerm[] getSponsorIdTerms()Gets the sponsorIdquery terms.- Returns:
- the sponsor
Idquery terms - Compliance:
mandatory- This method must be implemented.
-
getSponsorTerms
ResourceQueryInspector[] getSponsorTerms()Gets the sponsor query terms.- Returns:
- the sponsor query terms
- Compliance:
mandatory- This method must be implemented.
-
getParentProgramOfferingIdTerms
IdTerm[] getParentProgramOfferingIdTerms()Gets the parent program offeringIdquery terms.- Returns:
- the parent program offering
Idquery terms - Compliance:
mandatory- This method must be implemented.
-
getParentProgramOfferingTerms
ProgramOfferingQueryInspector[] getParentProgramOfferingTerms()Gets the parent program offering query terms.- Returns:
- the parent program offering query terms
- Compliance:
mandatory- This method must be implemented.
-
getLearningObjectiveIdTerms
IdTerm[] getLearningObjectiveIdTerms()Gets the objectiveIdquery terms.- Returns:
- the objective
Idquery terms - Compliance:
mandatory- This method must be implemented.
-
getLearningObjectiveTerms
ObjectiveQueryInspector[] getLearningObjectiveTerms()Gets the objective query terms.- Returns:
- the objective query terms
- Compliance:
mandatory- This method must be implemented.
-
getRestrictedAudienceIdTerms
IdTerm[] getRestrictedAudienceIdTerms()Gets the restricted audienceIdquery terms.- Returns:
- the restricted audience
Idquery terms - Compliance:
mandatory- This method must be implemented.
-
getRestrictedAudienceTerms
ResourceQueryInspector[] getRestrictedAudienceTerms()Gets the restricted audience query terms.- Returns:
- the restricted audience query terms
- Compliance:
mandatory- This method must be implemented.
-
getCompletionRequirementsInfoTerms
StringTerm[] getCompletionRequirementsInfoTerms()Gets the completion requirements query terms.- Returns:
- the prereq query terms
- Compliance:
mandatory- This method must be implemented.
-
getCompletionRequirementsIdTerms
IdTerm[] getCompletionRequirementsIdTerms()Gets the completion requirements requisiteIdquery terms.- Returns:
- the requisite
Idquery terms - Compliance:
mandatory- This method must be implemented.
-
getCompletionRequirementsTerms
RequisiteQueryInspector[] getCompletionRequirementsTerms()Gets the completion requirements requisite query terms.- Returns:
- the requisite query terms
- Compliance:
mandatory- This method must be implemented.
-
getCredentialIdTerms
IdTerm[] getCredentialIdTerms()Gets the credentialIdquery terms.- Returns:
- the grade system
Idquery terms - Compliance:
mandatory- This method must be implemented.
-
getCredentialTerms
CredentialQueryInspector[] getCredentialTerms()Gets the credential query terms.- Returns:
- the grade system terms
- Compliance:
mandatory- This method must be implemented.
-
getRequiresRegistrationTerms
BooleanTerm[] getRequiresRegistrationTerms()Gets the requires registration query terms.- Returns:
- the requires registration query terms
- Compliance:
mandatory- This method must be implemented.
-
getMinimumSeatsTerms
CardinalRangeTerm[] getMinimumSeatsTerms()Gets the minimum seats query terms.- Returns:
- the minimum seats query terms
- Compliance:
mandatory- This method must be implemented.
-
getMaximumSeatsTerms
CardinalRangeTerm[] getMaximumSeatsTerms()Gets the maximum seats query terms.- Returns:
- the maximum seats query terms
- Compliance:
mandatory- This method must be implemented.
-
getURLTerms
StringTerm[] getURLTerms()Gets the url query terms.- Returns:
- the url query terms
- Compliance:
mandatory- This method must be implemented.
-
getCourseCatalogIdTerms
IdTerm[] getCourseCatalogIdTerms()Gets the course catalogIdquery terms.- Returns:
- the course catalog
Idquery terms - Compliance:
mandatory- This method must be implemented.
-
getCourseCatalogTerms
CourseCatalogQueryInspector[] getCourseCatalogTerms()Gets the course catalog query terms.- Returns:
- the course catalog query terms
- Compliance:
mandatory- This method must be implemented.
-
getProgramOfferingQueryInspectorRecord
ProgramOfferingQueryInspectorRecord getProgramOfferingQueryInspectorRecord(Type programOfferingRecordType) throws OperationFailedException Gets the program offering query inspector record corresponding to the givenProgramOfferingrecordType. Multiple record retrievals produce a nestedORterm.- Parameters:
programOfferingRecordType- a program offering record type- Returns:
- the program offering query inspector record
- Throws:
NullArgumentException-programOfferingRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(programOfferingRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-