OSID Specifications
course chronicle package
Version 3.0.0
course chronicle package
Version 3.0.0
| Interface | osid.course.chronicle.CredentialEntryQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQueryInspector | ||
| Used By | osid.course.chronicle.CredentialEntrySearchResults | ||
osid.course.chronicle.CredentialEntrySmartCourseCatalogSession | |||
| Description |
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
| ||
| Method | getStudentIdTerms | ||
| Description |
Gets the resource | ||
| Return | osid.search.terms.IdTerm[] | the resource Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStudentTerms | ||
| Description |
Gets the student query terms. | ||
| Return | osid.resource.ResourceQueryInspector[] | the resource query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCredentialIdTerms | ||
| Description |
Gets the credential | ||
| Return | osid.search.terms.IdTerm[] | the credential Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCredentialTerms | ||
| Description |
Gets the credential query terms. | ||
| Return | osid.course.program.CredentialQueryInspector[] | the credential terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIsMatriculationKnownTerms | ||
| Description |
Gets the matriculation known query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the matriculation known terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStartDateTerms | ||
| Description |
Gets the start date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the start date terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStartTermIdTerms | ||
| Description |
Gets the start term | ||
| Return | osid.search.terms.IdTerm[] | the start term Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStartTermTerms | ||
| Description |
Gets the start term query terms. | ||
| Return | osid.course.TermQueryInspector[] | the start term terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIsExpectedToCompleteTerms | ||
| Description |
Gets the expected to complete query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the expected to complete terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExpectedCompletionDateTerms | ||
| Description |
Gets the expected completion date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the expected completion date terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExpectedCompletionTermIdTerms | ||
| Description |
Gets the expected completion term | ||
| Return | osid.search.terms.IdTerm[] | the expected completion term Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getExpectedCompletionTermTerms | ||
| Description |
Gets the expected completion term query terms. | ||
| Return | osid.course.TermQueryInspector[] | the expected completion term terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIsActivelyPursuingTerms | ||
| Description |
Gets the actively pursuing query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the actively pursuing terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIsPausedTerms | ||
| Description |
Gets the paused query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the paused terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIsAbandonedTerms | ||
| Description |
Gets the abandoned query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the abandoned terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAbandonDateTerms | ||
| Description |
Gets the abandon date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the abandon date terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAbandonTermIdTerms | ||
| Description |
Gets the abandon term | ||
| Return | osid.search.terms.IdTerm[] | the abandon term Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAbandonTermTerms | ||
| Description |
Gets the abandon term query terms. | ||
| Return | osid.course.TermQueryInspector[] | the abandon term terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIsAwardedTerms | ||
| Description |
Gets the awarded query terms. | ||
| Return | osid.search.terms.BooleanTerm[] | the awarded terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAwardDateTerms | ||
| Description |
Gets the award date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the award date terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAwardTermIdTerms | ||
| Description |
Gets the award term | ||
| Return | osid.search.terms.IdTerm[] | the award term Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAwardTermTerms | ||
| Description |
Gets the award term query terms. | ||
| Return | osid.course.TermQueryInspector[] | the award term terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDateAwardedTerms | ||
| Description |
Gets the award date query terms. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the date terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProgramIdTerms | ||
| Description |
Gets the program | ||
| Return | osid.search.terms.IdTerm[] | the program Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProgramTerms | ||
| Description |
Gets the program query terms. | ||
| Return | osid.course.program.ProgramQueryInspector[] | the program terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogIdTerms | ||
| Description |
Gets the course catalog | ||
| Return | osid.search.terms.IdTerm[] | the course catalog Id query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseCatalogTerms | ||
| Description |
Gets the course catalog query terms. | ||
| Return | osid.course.CourseCatalogQueryInspector[] | the course catalog query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCredentialEntryQueryInspectorRecord | ||
| Description |
Gets the credential entry query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | credentialEntryRecordType | a credential entry record type |
| Return | osid.course.chronicle.records.CredentialEntryQueryInspectorRecord | the credential entry query inspector record | |
| Errors | NULL_ARGUMENT | credentialEntryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(credentialEntryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |