Interface | osid.course.program.ProgramLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving programs. A P
This lookup session defines several views:
The methods Programs may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
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 | canLookupPrograms | ||
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 | useComparativeProgramView | ||
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 | usePlenaryProgramView | ||
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 programs in catalogs which are children of this 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 retrievals to this course catalog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveProgramView | ||
Description |
Only active programs are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusProgramView | ||
Description |
All programs of any active or inactive status are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProgram | ||
Description |
Gets the In active mode, active programs are returned. In any status mode, active and inactive programs are returned. | ||
Parameters | osid.id.Id | programId | the Id of the Program to retrieve |
Return | osid.course.program.Program | the returned Program | |
Errors | NOT_FOUND | no program found with the given Id | |
NULL_ARGUMENT | programId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramsByIds | ||
Description |
Gets a In active mode, active programs are returned. In any status mode, active and inactive programs are returned. | ||
Parameters | osid.id.IdList | programIds | the list of Ids to retrieve |
Return | osid.course.program.ProgramList | the returned ProgramList list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | programIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramsByGenusType | ||
Description |
Gets a In active mode, active programs are returned. In any status mode, active and inactive programs are returned. | ||
Parameters | osid.type.Type | programGenusType | a program genus type |
Return | osid.course.program.ProgramList | the returned ProgramList list | |
Errors | NULL_ARGUMENT | programGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramsByParentGenusType | ||
Description |
Gets a In active mode, active programs are returned. In any status mode, active and inactive programs are returned. | ||
Parameters | osid.type.Type | programGenusType | a program genus type |
Return | osid.course.program.ProgramList | the returned ProgramList list | |
Errors | NULL_ARGUMENT | programGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramsByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known programs or an error results. Otherwise, the returned list may contain only those programs that are accessible through this session. In active mode, active programs are returned. In any status mode, active and inactive programs are returned. | ||
Parameters | osid.type.Type | programRecordType | a program record type |
Return | osid.course.program.ProgramList | the returned ProgramList list | |
Errors | NULL_ARGUMENT | programRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramsByCredential | ||
Description |
Gets a In plenary mode, the returned list contains all known programs or an error results. Otherwise, the returned list may contain only those programs that are accessible through this session. In active mode, active programs are returned. In any status mode, active and inactive programs are returned. | ||
Parameters | osid.id.Id | credentialId | a credential Id |
Return | osid.course.program.ProgramList | the returned ProgramList list | |
Errors | NULL_ARGUMENT | credentialId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPrograms | ||
Description |
Gets all In plenary mode, the returned list contains all known programs or an error results. Otherwise, the returned list may contain only those programs that are accessible through this session. In active mode, active programs are returned. In any status mode, active and inactive programs are returned. | ||
Return | osid.course.program.ProgramList | a list of Programs | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |