Interface | osid.course.requisite.RequisiteLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving requirements and requirement components. This lookup session defines several views:
The methods Requisites 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 | canLookupRequisites | ||
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 | useComparativeRequisiteView | ||
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 | usePlenaryRequisiteView | ||
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 requisites 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 | useActiveRequisiteView | ||
Description |
Only active requisites are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusRequisiteView | ||
Description |
All active and inactive requisites are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useSequesteredRequisiteView | ||
Description |
The returns from the lookup methods omit sequestered requisites. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useUnsequesteredRequisiteView | ||
Description |
All requisites are returned including sequestered requisites. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRequisite | ||
Description |
Gets the In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned. | ||
Parameters | osid.id.Id | requisiteId | the Id of the Requisite to retrieve |
Return | osid.course.requisite.Requisite | the returned requisite | |
Errors | NOT_FOUND | no Requisite found with the given Id | |
NULL_ARGUMENT | requisiteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesByIds | ||
Description |
Gets a In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned. | ||
Parameters | osid.id.IdList | requisiteIds | the list of Ids to retrieve |
Return | osid.course.requisite.RequisiteList | the returned RequisiteList | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | requisiteIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesByGenusType | ||
Description |
Gets a In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned. | ||
Parameters | osid.type.Type | requisiteGenusType | a requisite genus type |
Return | osid.course.requisite.RequisiteList | the returned RequisiteList | |
Errors | NULL_ARGUMENT | requisiteGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesByParentGenusType | ||
Description |
Gets a In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned. | ||
Parameters | osid.type.Type | requisiteGenusType | a requisite genus type |
Return | osid.course.requisite.RequisiteList | the returned RequisiteList | |
Errors | NULL_ARGUMENT | requisiteGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned. | ||
Parameters | osid.type.Type | requisiteRecordType | a requisite record type |
Return | osid.course.requisite.RequisiteList | the returned RequisiteList list | |
Errors | NULL_ARGUMENT | requisiteRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesForRequisiteOption | ||
Description |
Gets a In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned. | ||
Parameters | osid.id.Id | requisiteOptionId | a requisite option Id |
Return | osid.course.requisite.RequisiteList | the returned RequisiteList | |
Errors | NULL_ARGUMENT | requisiteOptionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisites | ||
Description |
Gets all In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned. | ||
Return | osid.course.requisite.RequisiteList | a list of Requisites | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseRequirement | ||
Description |
Gets the In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned. | ||
Parameters | osid.id.Id | courseRequirementId | the Id of the CourseRequirement to retrieve |
Return | osid.course.requisite.CourseRequirement | the returned CourseRequirement | |
Errors | NOT_FOUND | no CourseRequirement found with the given Id | |
NULL_ARGUMENT | courseRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseRequirementsByIds | ||
Description |
Gets a In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned. | ||
Parameters | osid.id.IdList | courseRequirementIds | the list of Ids to retrieve |
Return | osid.course.requisite.CourseRequirementList | the returned CourseRequirementList list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | courseRequirementIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseRequirementsByGenusType | ||
Description |
Gets a In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned. | ||
Parameters | osid.type.Type | courseRequirementGenusType | a course requirement genus type |
Return | osid.course.requisite.CourseRequirementList | the returned CourseRequirementList | |
Errors | NULL_ARGUMENT | courseRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseRequirementsByParentGenusType | ||
Description |
Gets a In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned. | ||
Parameters | osid.type.Type | courseRequirementGenusType | a course requirements genus type |
Return | osid.course.requisite.CourseRequirementList | the returned CourseRequirementList | |
Errors | NULL_ARGUMENT | courseRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseRequirementsByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known course requirements or an error results. Otherwise, the returned list may contain only those course requirements that are accessible through this session. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned. | ||
Parameters | osid.type.Type | courseRequirementRecordType | a course requirement record type |
Return | osid.course.requisite.CourseRequirementList | the returned CourseRequirementList | |
Errors | NULL_ARGUMENT | courseRequirementRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseRequirementsByCourse | ||
Description |
Gets a In plenary mode, the returned list contains all known course requirements or an error results. Otherwise, the returned list may contain only those course requirements that are accessible through this session. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned. | ||
Parameters | osid.id.Id | courseId | a course Id |
Return | osid.course.requisite.CourseRequirementList | the returned CourseRequirementList | |
Errors | NULL_ARGUMENT | courseId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseRequirementsByAltRequisite | ||
Description |
Gets a In plenary mode, the returned list contains all known course requirements or an error results. Otherwise, the returned list may contain only those course requirements that are accessible through this session. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned. | ||
Parameters | osid.id.Id | requisiteId | a requisite Id |
Return | osid.course.requisite.CourseRequirementList | the returned CourseRequirementList | |
Errors | NULL_ARGUMENT | requisiteId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesForCourseRequirement | ||
Description |
Gets a In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, course requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. | ||
Parameters | osid.id.Id | courseRequirementId | a course requirement Id |
Return | osid.course.requisite.RequisiteList | the returned RequisiteList | |
Errors | NULL_ARGUMENT | courseRequirementId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseRequirements | ||
Description |
Gets all In plenary mode, the returned list contains all known course requirements or an error results. Otherwise, the returned list may contain only those course requirements that are accessible through this session. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned. | ||
Return | osid.course.requisite.CourseRequirementList | a list of CourseRequirements | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramRequirement | ||
Description |
Gets the In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned. | ||
Parameters | osid.id.Id | programRequirementId | the Id of the ProgramRequirement to retrieve |
Return | osid.course.requisite.ProgramRequirement | the returned ProgramRequirement | |
Errors | NOT_FOUND | no ProgramRequirement found with the given Id | |
NULL_ARGUMENT | programRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramRequirementsByIds | ||
Description |
Gets a In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned. | ||
Parameters | osid.id.IdList | programRequirementIds | the list of Ids to retrieve |
Return | osid.course.requisite.ProgramRequirementList | the returned ProgramRequirementList list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | programRequirementIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramRequirementsByGenusType | ||
Description |
Gets a In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned. | ||
Parameters | osid.type.Type | programRequirementGenusType | a program requirement genus type |
Return | osid.course.requisite.ProgramRequirementList | the returned ProgramRequirementList | |
Errors | NULL_ARGUMENT | programRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramRequirementsByParentGenusType | ||
Description |
Gets a In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned. | ||
Parameters | osid.type.Type | programRequirementGenusType | a program requirements genus type |
Return | osid.course.requisite.ProgramRequirementList | the returned ProgramRequirementList | |
Errors | NULL_ARGUMENT | programRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramRequirementsByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known program requirements or an error results. Otherwise, the returned list may contain only those program requirements that are accessible through this session. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned. | ||
Parameters | osid.type.Type | programRequirementRecordType | a program requirement record type |
Return | osid.course.requisite.ProgramRequirementList | the returned ProgramRequirementList | |
Errors | NULL_ARGUMENT | programRequirementRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramRequirementsByProgram | ||
Description |
Gets a In plenary mode, the returned list contains all known program requirements or an error results. Otherwise, the returned list may contain only those program requirements that are accessible through this session. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned. | ||
Parameters | osid.id.Id | programId | a program Id |
Return | osid.course.requisite.ProgramRequirementList | the returned ProgramRequirementList | |
Errors | NULL_ARGUMENT | programId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramRequirementsByAltRequisite | ||
Description |
Gets a In plenary mode, the returned list contains all known program requirements or an error results. Otherwise, the returned list may contain only those program requirements that are accessible through this session. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned. | ||
Parameters | osid.id.Id | requisiteId | a requisite Id |
Return | osid.course.requisite.ProgramRequirementList | the returned ProgramRequirementList | |
Errors | NULL_ARGUMENT | requisiteId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesForProgramRequirement | ||
Description |
Gets a In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, program requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. | ||
Parameters | osid.id.Id | programRequirementId | a program requirement Id |
Return | osid.course.requisite.RequisiteList | the returned RequisiteList | |
Errors | NULL_ARGUMENT | programRequirementId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramRequirements | ||
Description |
Gets all In plenary mode, the returned list contains all known program requirements or an error results. Otherwise, the returned list may contain only those program requirements that are accessible through this session. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned. | ||
Return | osid.course.requisite.ProgramRequirementList | a list of ProgramRequirements | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialRequirement | ||
Description |
Gets the In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned. | ||
Parameters | osid.id.Id | credentialRequirementId | the Id of the CredentialRequirement to
retrieve |
Return | osid.course.requisite.CredentialRequirement | the returned CredentialRequirement | |
Errors | NOT_FOUND | no CredentialRequirement found with the given Id
| |
NULL_ARGUMENT | credentialRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialRequirementsByIds | ||
Description |
Gets a In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned. | ||
Parameters | osid.id.IdList | credentialRequirementIds | the list of Ids to retrieve |
Return | osid.course.requisite.CredentialRequirementList | the returned CredentialRequirementList list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | credentialRequirementIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialRequirementsByGenusType | ||
Description |
Gets a In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned. | ||
Parameters | osid.type.Type | credentialRequirementGenusType | a credential requirement genus type |
Return | osid.course.requisite.CredentialRequirementList | the returned CredentialRequirementList | |
Errors | NULL_ARGUMENT | credentialRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialRequirementsByParentGenusType | ||
Description |
Gets a In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned. | ||
Parameters | osid.type.Type | credentialRequirementGenusType | a credential requirements genus type |
Return | osid.course.requisite.CredentialRequirementList | the returned CredentialRequirementList | |
Errors | NULL_ARGUMENT | credentialRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialRequirementsByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known credential requirements or an error results. Otherwise, the returned list may contain only those credential requirements that are accessible through this session. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned. | ||
Parameters | osid.type.Type | credentialRequirementRecordType | a credential requirement record type |
Return | osid.course.requisite.CredentialRequirementList | the returned CredentialRequirementList | |
Errors | NULL_ARGUMENT | credentialRequirementRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialRequirementsByCredential | ||
Description |
Gets a In plenary mode, the returned list contains all known credential requirements or an error results. Otherwise, the returned list may contain only those credential requirements that are accessible through this session. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned. | ||
Parameters | osid.id.Id | credentialId | a credential Id |
Return | osid.course.requisite.CredentialRequirementList | the returned CredentialRequirementList | |
Errors | NULL_ARGUMENT | credentialId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialRequirementsByAltRequisite | ||
Description |
Gets a In plenary mode, the returned list contains all known credential requirements or an error results. Otherwise, the returned list may contain only those credential requirements that are accessible through this session. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned. | ||
Parameters | osid.id.Id | requisiteId | a requisite Id |
Return | osid.course.requisite.CredentialRequirementList | the returned CredentialRequirementList | |
Errors | NULL_ARGUMENT | requisiteId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesForCredentialRequirement | ||
Description |
Gets a In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, credential requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. | ||
Parameters | osid.id.Id | credentialRequirementId | a credential requirement Id |
Return | osid.course.requisite.RequisiteList | the returned RequisiteList | |
Errors | NULL_ARGUMENT | credentialRequirementId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialRequirements | ||
Description |
Gets all In plenary mode, the returned list contains all known credential requirements or an error results. Otherwise, the returned list may contain only those credential requirements that are accessible through this session. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned. | ||
Return | osid.course.requisite.CredentialRequirementList | a list of CredentialRequirements | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveRequirement | ||
Description |
Gets the In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned. | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | the Id of the LearningObjectiveRequirement to
retrieve |
Return | osid.course.requisite.LearningObjectiveRequirement | the returned LearningObjectiveRequirement | |
Errors | NOT_FOUND | no LearningObjectiveRequirement found with the given
Id | |
NULL_ARGUMENT | learningObjectiveRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveRequirementsByIds | ||
Description |
Gets a In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned. | ||
Parameters | osid.id.IdList | learningObjectiveRequirementIds | the list of Ids to retrieve |
Return | osid.course.requisite.LearningObjectiveRequirementList | the returned LearningObjectiveRequirement list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | learningObjectiveRequirementIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveRequirementsByGenusType | ||
Description |
Gets a In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned. | ||
Parameters | osid.type.Type | learningObjectiveRequirementGenusType | a learning objective requirement genus type |
Return | osid.course.requisite.LearningObjectiveRequirementList | the returned LearningObjectiveRequirementList | |
Errors | NULL_ARGUMENT | learningObjectiveRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveRequirementsByParentGenusType | ||
Description |
Gets a In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned. | ||
Parameters | osid.type.Type | learningObjectiveRequirementGenusType | a learning objective requirements genus type |
Return | osid.course.requisite.LearningObjectiveRequirementList | the returned LearningObjectiveRequirementList | |
Errors | NULL_ARGUMENT | learningObjectiveRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveRequirementsByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known learning objective requirements or an error results. Otherwise, the returned list may contain only those learning objective requirements that are accessible through this session. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned. | ||
Parameters | osid.type.Type | learningObjectiveRequirementRecordType | a learning objective requirement record type |
Return | osid.course.requisite.LearningObjectiveRequirementList | the returned LearningObjectiveRequirementList | |
Errors | NULL_ARGUMENT | learningObjectiverequirementRecordType is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveRequirementsByObjective | ||
Description |
Gets a In plenary mode, the returned list contains all known learning objective requirements or an error results. Otherwise, the returned list may contain only those learning objective requirements that are accessible through this session. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned. | ||
Parameters | osid.id.Id | objectiveId | a learning objective Id |
Return | osid.course.requisite.LearningObjectiveRequirementList | the returned LearningObjectiveRequirementList | |
Errors | NULL_ARGUMENT | objectiveId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveRequirementsByAltRequisite | ||
Description |
Gets a In plenary mode, the returned list contains all known learning objective requirements or an error results. Otherwise, the returned list may contain only those learning objective requirements that are accessible through this session. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned. | ||
Parameters | osid.id.Id | requisiteId | a requisite Id |
Return | osid.course.requisite.LearningObjectiveRequirementList | the returned LearningObjectiveRequirementList | |
Errors | NULL_ARGUMENT | requisiteId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesForLearningObjectiveRequirement | ||
Description |
Gets a In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, learning objective requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive requirements are returned. | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | a learning objective requirement Id |
Return | osid.course.requisite.RequisiteList | the returned RequisiteList | |
Errors | NULL_ARGUMENT | learningObjectiveRequirementId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveRequirements | ||
Description |
Gets all In plenary mode, the returned list contains all known learning objective requirements or an error results. Otherwise, the returned list may contain only those learning objective requirements that are accessible through this session. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned. | ||
Return | osid.course.requisite.LearningObjectiveRequirementList | a list of LearningObjectiveRequirements | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentRequirement | ||
Description |
Gets the In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned. | ||
Parameters | osid.id.Id | assessmentRequirementId | the Id of the AssessmentRequirement to
retrieve |
Return | osid.course.requisite.AssessmentRequirement | the returned AssessmentRequirement | |
Errors | NOT_FOUND | no AssessmentRequirement found with the given Id
| |
NULL_ARGUMENT | assessmentRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentRequirementsByIds | ||
Description |
Gets an In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned. | ||
Parameters | osid.id.IdList | assessmentRequirementIds | the list of Ids to retrieve |
Return | osid.course.requisite.AssessmentRequirementList | a list of AssessmentRequirements | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | assessmentRequirementIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentRequirementsByGenusType | ||
Description |
Gets an In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned. | ||
Parameters | osid.type.Type | assessmentRequirementGenusType | an assessment requirement genus type |
Return | osid.course.requisite.AssessmentRequirementList | a list of AssessmentRequirements | |
Errors | NULL_ARGUMENT | assessmentRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentRequirementsByParentGenusType | ||
Description |
Gets an In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned. | ||
Parameters | osid.type.Type | assessmentRequirementGenusType | an assessment requirements genus type |
Return | osid.course.requisite.AssessmentRequirementList | a list of AssessmentRequirements | |
Errors | NULL_ARGUMENT | assessmentRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentRequirementsByRecordType | ||
Description |
Gets an In plenary mode, the returned list contains all known assessment requirements or an error results. Otherwise, the returned list may contain only those assessment requirements that are accessible through this session. In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned. | ||
Parameters | osid.type.Type | assessmentRequirementRecordType | an assessment requirement record type |
Return | osid.course.requisite.AssessmentRequirementList | a list of AssessmentRequirements | |
Errors | NULL_ARGUMENT | assessmentRequirementRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentRequirementsByAssessment | ||
Description |
Gets an | ||
Parameters | osid.id.Id | assessmentId | an assessment Id |
Return | osid.course.requisite.AssessmentRequirementList | a list of AssessmentRequirements | |
Errors | NULL_ARGUMENT | assessmentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentRequirementsByAltRequisite | ||
Description |
Gets an In plenary mode, the returned list contains all known assessment requirements or an error results. Otherwise, the returned list may contain only those assessment requirements that are accessible through this session. In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned. | ||
Parameters | osid.id.Id | requisiteId | a requisite Id |
Return | osid.course.requisite.AssessmentRequirementList | a list of AssessmentRequirements | |
Errors | NULL_ARGUMENT | requisiteId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesForAssessmentRequirement | ||
Description |
Gets a In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, assessment requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive assessment requirements are returned. | ||
Parameters | osid.id.Id | assessmentRequirementId | an assessment requirement Id |
Return | osid.course.requisite.RequisiteList | a list of Requisites | |
Errors | NULL_ARGUMENT | assessmentRequirementId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentRequirements | ||
Description |
Gets all In plenary mode, the returned list contains all known assessment requirements or an error results. Otherwise, the returned list may contain only those assessment requirements that are accessible through this session. In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned. | ||
Return | osid.course.requisite.AssessmentRequirementList | a list of AssessmentRequirements | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardRequirement | ||
Description |
Gets the In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned. | ||
Parameters | osid.id.Id | awardRequirementId | the Id of the AwardRequirement to retrieve |
Return | osid.course.requisite.AwardRequirement | the returned AwardRequirement | |
Errors | NOT_FOUND | no AwardRequirement found with the given Id | |
NULL_ARGUMENT | awardRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardRequirementsByIds | ||
Description |
Gets an In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned. | ||
Parameters | osid.id.IdList | awardRequirementIds | the list of Ids to retrieve |
Return | osid.course.requisite.AwardRequirementList | a list of AwardRequirements | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | awardRequirementIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardRequirementsByGenusType | ||
Description |
Gets an In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned. | ||
Parameters | osid.type.Type | awardRequirementGenusType | an award requirement genus type |
Return | osid.course.requisite.AwardRequirementList | a list of AwardRequirements | |
Errors | NULL_ARGUMENT | awardRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardRequirementsByParentGenusType | ||
Description |
Gets an In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned. | ||
Parameters | osid.type.Type | awardRequirementGenusType | an award requirements genus type |
Return | osid.course.requisite.AwardRequirementList | a list of AwardRequirements | |
Errors | NULL_ARGUMENT | awardRequirementGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardRequirementsByRecordType | ||
Description |
Gets an In plenary mode, the returned list contains all known award requirements or an error results. Otherwise, the returned list may contain only those award requirements that are accessible through this session. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned. | ||
Parameters | osid.type.Type | awardRequirementRecordType | an award requirement record type |
Return | osid.course.requisite.AwardRequirementList | a list of AwardRequirements | |
Errors | NULL_ARGUMENT | awardRequirementRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardRequirementsByAward | ||
Description |
Gets an In plenary mode, the returned list contains all known award requirements or an error results. Otherwise, the returned list may contain only those award requirements that are accessible through this session. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned. | ||
Parameters | osid.id.Id | awardId | an award Id |
Return | osid.course.requisite.AwardRequirementList | a list of AwardRequirements | |
Errors | NULL_ARGUMENT | awardId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardRequirementsByAltRequisite | ||
Description |
Gets an In plenary mode, the returned list contains all known award requirements or an error results. Otherwise, the returned list may contain only those award requirements that are accessible through this session. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned. | ||
Parameters | osid.id.Id | requisiteId | a requisite Id |
Return | osid.course.requisite.AwardRequirementList | a list of AwardRequirements | |
Errors | NULL_ARGUMENT | requisiteId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesForAwardRequirement | ||
Description |
Gets a In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, award requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. | ||
Parameters | osid.id.Id | awardRequirementId | an award requirement Id |
Return | osid.course.requisite.RequisiteList | a list of Requisites | |
Errors | NULL_ARGUMENT | awardRequirementId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardRequirements | ||
Description |
Gets all In plenary mode, the returned list contains all known award requirements or an error results. Otherwise, the returned list may contain only those award requirements that are accessible through this session. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned. | ||
Return | osid.course.requisite.AwardRequirementList | a list of AwardRequirements | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |