Interface | osid.course.TermLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupTerms | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeTermView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryTermView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCourseCatalogView | ||
Description |
Federates the view for methods in this session. A federated view will include terms in course catalogs which are children of this course catalog in the course catalog hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCourseCatalogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getTerm | ||
Description |
Gets the | ||
Parameters | osid.id.Id | termId | Id of the Term |
Return | osid.course.Term | the term | |
Errors | NOT_FOUND | termId not found | |
NULL_ARGUMENT | termId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getTermsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | termIds | the list of Ids to retrieve |
Return | osid.course.TermList | the returned Term list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | termIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTermsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | termGenusType | a term genus type |
Return | osid.course.TermList | the returned Term list | |
Errors | NULL_ARGUMENT | termGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTermsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | termGenusType | a term genus type |
Return | osid.course.TermList | the returned Term list | |
Errors | NULL_ARGUMENT | termGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTermsByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | termRecordType | a term record type |
Return | osid.course.TermList | the returned Term list | |
Errors | NULL_ARGUMENT | termRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTermsByClassesDate | ||
Description |
Gets a | ||
Parameters | osid.calendaring.DateTime | datetime | a date |
Return | osid.course.TermList | the returned Term list | |
Errors | NULL_ARGUMENT | datetime is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTerms | ||
Description |
Gets all | ||
Return | osid.course.TermList | a list of Terms | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |