OSID Logo
OSID Specifications
course requisite package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.requisite.RequisiteLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving requirements and requirement components.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated course catalog view: All requisite methods in this session operate, retrieve and pertain to requisites defined explicitly in the current course catalog. Using an isolated view is useful for managing Requisites with the Requisite AdminSession.
  • federated course catalog view: All requisite lookup methods in this session operate, retrieve and pertain to all requisites defined in this course catalog and any other requisites implicitly available in this course catalog through course catalog inheritence.
  • active requisite view: All requisite lookup methods return active requisites.
  • any status requisite view: Requisite of any active or inactive status are returned from methods.
  • sequestered requisite viiew: All requisite methods suppress sequestered requisites.
  • unsequestered requisite view: All requisite methods return all requisites.

The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

Requisites may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Requisite.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupRequisites
Description

Tests if this user can perform Requisite and component lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeRequisiteView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryRequisiteView
Description

A complete view of the Requisite returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedCourseCatalogView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveRequisiteView
Description

Only active requisites are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusRequisiteView
Description

All active and inactive requisites are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseSequesteredRequisiteView
Description

The returns from the lookup methods omit sequestered requisites.

CompliancemandatoryThis method is must be implemented.
MethoduseUnsequesteredRequisiteView
Description

All requisites are returned including sequestered requisites.

CompliancemandatoryThis method is must be implemented.
MethodgetRequisite
Description

Gets the Requisite specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Requisite may have a different Id than requested, such as the case where a duplicate Id was assigned to a Requisite and retained for compatibility.

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.

Parametersosid.id.IdrequisiteIdthe Id of the Requisite to retrieve
Returnosid.course.requisite.Requisitethe returned requisite
ErrorsNOT_FOUNDno Requisite found with the given Id
NULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesByIds
Description

Gets a RequisiteList corresponding to the given IdList.

In plenary mode, the returned list contains all of the requisites specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Requisites may be omitted from the list and may present the elements in any order including returning a unique set.

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.

Parametersosid.id.IdListrequisiteIdsthe list of Ids to retrieve
Returnosid.course.requisite.RequisiteListthe returned RequisiteList
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT requisiteIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesByGenusType
Description

Gets a RequisiteList corresponding to the given requisite genus Type which does not include requisites of types derived from the specified Type.

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.

Parametersosid.type.TyperequisiteGenusTypea requisite genus type
Returnosid.course.requisite.RequisiteListthe returned RequisiteList
ErrorsNULL_ARGUMENT requisiteGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesByParentGenusType
Description

Gets a RequisiteList corresponding to the given requisite genus Type and include any additional requisites with genus types derived from the specified Type.

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.

Parametersosid.type.TyperequisiteGenusTypea requisite genus type
Returnosid.course.requisite.RequisiteListthe returned RequisiteList
ErrorsNULL_ARGUMENT requisiteGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesByRecordType
Description

Gets a RequisiteList containing the given requisite record Type.

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.

Parametersosid.type.TyperequisiteRecordTypea requisite record type
Returnosid.course.requisite.RequisiteListthe returned RequisiteList list
ErrorsNULL_ARGUMENT requisiteRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesForRequisiteOption
Description

Gets a RequisiteList immediately containing the given requisite option.

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.

Parametersosid.id.IdrequisiteOptionIda requisite option Id
Returnosid.course.requisite.RequisiteListthe returned RequisiteList
ErrorsNULL_ARGUMENT requisiteOptionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisites
Description

Gets all Requisites.

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.

Returnosid.course.requisite.RequisiteLista list of Requisites
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseRequirement
Description

Gets the CourseRequirement specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned CourseRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to a CourseRequirement and retained for compatibility.

In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned.

Parametersosid.id.IdcourseRequirementIdthe Id of the CourseRequirement to retrieve
Returnosid.course.requisite.CourseRequirementthe returned CourseRequirement
ErrorsNOT_FOUNDno CourseRequirement found with the given Id
NULL_ARGUMENT courseRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseRequirementsByIds
Description

Gets a CourseRequirementList corresponding to the given IdList.

In plenary mode, the returned list contains all of the course requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible CourseRequirements may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned.

Parametersosid.id.IdListcourseRequirementIdsthe list of Ids to retrieve
Returnosid.course.requisite.CourseRequirementListthe returned CourseRequirementList list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT courseRequirementIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseRequirementsByGenusType
Description

Gets a CourseRequirementList corresponding to the given course requirement genus Type which does not include course requirements of types derived from the specified Type.

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.

Parametersosid.type.TypecourseRequirementGenusTypea course requirement genus type
Returnosid.course.requisite.CourseRequirementListthe returned CourseRequirementList
ErrorsNULL_ARGUMENT courseRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseRequirementsByParentGenusType
Description

Gets a CourseRequirementList corresponding to the given course requirement genus Type and include any additional course requirements with genus types derived from the specified Type.

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.

Parametersosid.type.TypecourseRequirementGenusTypea course requirements genus type
Returnosid.course.requisite.CourseRequirementListthe returned CourseRequirementList
ErrorsNULL_ARGUMENT courseRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseRequirementsByRecordType
Description

Gets a CourseRequirementList containing the given course requirement record Type.

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.

Parametersosid.type.TypecourseRequirementRecordTypea course requirement record type
Returnosid.course.requisite.CourseRequirementListthe returned CourseRequirementList
ErrorsNULL_ARGUMENT courseRequirementRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseRequirementsByCourse
Description

Gets a CourseRequirementList containing the given course.

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.

Parametersosid.id.IdcourseIda course Id
Returnosid.course.requisite.CourseRequirementListthe returned CourseRequirementList
ErrorsNULL_ARGUMENT courseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseRequirementsByAltRequisite
Description

Gets a CourseRequirementList with the given Requisite.

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.

Parametersosid.id.IdrequisiteIda requisite Id
Returnosid.course.requisite.CourseRequirementListthe returned CourseRequirementList
ErrorsNULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesForCourseRequirement
Description

Gets a RequisiteList immediately containing the given course requirement.

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.

Parametersosid.id.IdcourseRequirementIda course requirement Id
Returnosid.course.requisite.RequisiteListthe returned RequisiteList
ErrorsNULL_ARGUMENT courseRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseRequirements
Description

Gets all CourseRequirements.

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.

Returnosid.course.requisite.CourseRequirementLista list of CourseRequirements
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramRequirement
Description

Gets the ProgramRequirement specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ProgramRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to a ProgramRequirement and retained for compatibility.

In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned.

Parametersosid.id.IdprogramRequirementIdthe Id of the ProgramRequirement to retrieve
Returnosid.course.requisite.ProgramRequirementthe returned ProgramRequirement
ErrorsNOT_FOUNDno ProgramRequirement found with the given Id
NULL_ARGUMENT programRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramRequirementsByIds
Description

Gets a ProgramRequirementList corresponding to the given IdList.

In plenary mode, the returned list contains all of the program requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible ProgramRequirements may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned.

Parametersosid.id.IdListprogramRequirementIdsthe list of Ids to retrieve
Returnosid.course.requisite.ProgramRequirementListthe returned ProgramRequirementList list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT programRequirementIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramRequirementsByGenusType
Description

Gets a ProgramRequirementList corresponding to the given program requirement genus Type which does not include program requirements of types derived from the specified Type.

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.

Parametersosid.type.TypeprogramRequirementGenusTypea program requirement genus type
Returnosid.course.requisite.ProgramRequirementListthe returned ProgramRequirementList
ErrorsNULL_ARGUMENT programRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramRequirementsByParentGenusType
Description

Gets a ProgramRequirementList corresponding to the given program requirement genus Type and include any additional program requirements with genus types derived from the specified Type.

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.

Parametersosid.type.TypeprogramRequirementGenusTypea program requirements genus type
Returnosid.course.requisite.ProgramRequirementListthe returned ProgramRequirementList
ErrorsNULL_ARGUMENT programRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramRequirementsByRecordType
Description

Gets a ProgramRequirementList containing the given program requirement record Type.

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.

Parametersosid.type.TypeprogramRequirementRecordTypea program requirement record type
Returnosid.course.requisite.ProgramRequirementListthe returned ProgramRequirementList
ErrorsNULL_ARGUMENT programRequirementRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramRequirementsByProgram
Description

Gets a ProgramRequirementList containing the given program.

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.

Parametersosid.id.IdprogramIda program Id
Returnosid.course.requisite.ProgramRequirementListthe returned ProgramRequirementList
ErrorsNULL_ARGUMENT programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramRequirementsByAltRequisite
Description

Gets a ProgramRequirementList with the given Requisite.

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.

Parametersosid.id.IdrequisiteIda requisite Id
Returnosid.course.requisite.ProgramRequirementListthe returned ProgramRequirementList
ErrorsNULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesForProgramRequirement
Description

Gets a RequisiteList immediately containing the given program requirement.

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.

Parametersosid.id.IdprogramRequirementIda program requirement Id
Returnosid.course.requisite.RequisiteListthe returned RequisiteList
ErrorsNULL_ARGUMENT programRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramRequirements
Description

Gets all ProgramRequirements.

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.

Returnosid.course.requisite.ProgramRequirementLista list of ProgramRequirements
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRequirement
Description

Gets the CredentialRequirement specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned CredentialRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to a CredentialRequirement and retained for compatibility.

In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned.

Parametersosid.id.IdcredentialRequirementIdthe Id of the CredentialRequirement to retrieve
Returnosid.course.requisite.CredentialRequirementthe returned CredentialRequirement
ErrorsNOT_FOUNDno CredentialRequirement found with the given Id
NULL_ARGUMENT credentialRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRequirementsByIds
Description

Gets a CredentialRequirementList corresponding to the given IdList.

In plenary mode, the returned list contains all of the credential requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible CredentialRequirements may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned.

Parametersosid.id.IdListcredentialRequirementIdsthe list of Ids to retrieve
Returnosid.course.requisite.CredentialRequirementListthe returned CredentialRequirementList list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT credentialRequirementIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRequirementsByGenusType
Description

Gets a CredentialRequirementList corresponding to the given credential requirement genus Type which does not include credential requirements of types derived from the specified Type.

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.

Parametersosid.type.TypecredentialRequirementGenusTypea credential requirement genus type
Returnosid.course.requisite.CredentialRequirementListthe returned CredentialRequirementList
ErrorsNULL_ARGUMENT credentialRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRequirementsByParentGenusType
Description

Gets a CredentialRequirementList corresponding to the given credential requirement genus Type and include any additional credential requirements with genus types derived from the specified Type.

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.

Parametersosid.type.TypecredentialRequirementGenusTypea credential requirements genus type
Returnosid.course.requisite.CredentialRequirementListthe returned CredentialRequirementList
ErrorsNULL_ARGUMENT credentialRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRequirementsByRecordType
Description

Gets a CredentialRequirementList containing the given credential requirement record Type.

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.

Parametersosid.type.TypecredentialRequirementRecordTypea credential requirement record type
Returnosid.course.requisite.CredentialRequirementListthe returned CredentialRequirementList
ErrorsNULL_ARGUMENT credentialRequirementRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRequirementsByCredential
Description

Gets a CredentialRequirementList containing the given credential.

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.

Parametersosid.id.IdcredentialIda credential Id
Returnosid.course.requisite.CredentialRequirementListthe returned CredentialRequirementList
ErrorsNULL_ARGUMENT credentialId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRequirementsByAltRequisite
Description

Gets a CredentialRequirementList with the given Requisite.

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.

Parametersosid.id.IdrequisiteIda requisite Id
Returnosid.course.requisite.CredentialRequirementListthe returned CredentialRequirementList
ErrorsNULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesForCredentialRequirement
Description

Gets a RequisiteList immediately containing the given credential requirement.

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.

Parametersosid.id.IdcredentialRequirementIda credential requirement Id
Returnosid.course.requisite.RequisiteListthe returned RequisiteList
ErrorsNULL_ARGUMENT credentialRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRequirements
Description

Gets all CredentialRequirements.

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.

Returnosid.course.requisite.CredentialRequirementLista list of CredentialRequirements
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveRequirement
Description

Gets the LearningObjectiveRequirement specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned LearningObjectiveRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to a LearningObjectiveRequirement and retained for compatibility.

In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of the LearningObjectiveRequirement to retrieve
Returnosid.course.requisite.LearningObjectiveRequirementthe returned LearningObjectiveRequirement
ErrorsNOT_FOUNDno LearningObjectiveRequirement found with the given Id
NULL_ARGUMENT learningObjectiveRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveRequirementsByIds
Description

Gets a LearningObjectiveRequirementList corresponding to the given IdList.

In plenary mode, the returned list contains all of the learning objective requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible LearningObjectiveRequirements may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned.

Parametersosid.id.IdListlearningObjectiveRequirementIdsthe list of Ids to retrieve
Returnosid.course.requisite.LearningObjectiveRequirementListthe returned LearningObjectiveRequirement list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT learningObjectiveRequirementIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveRequirementsByGenusType
Description

Gets a LearningObjectiveRequirementList corresponding to the given learning objective requirement genus Type which does not include learning objective requirements of types derived from the specified Type.

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.

Parametersosid.type.TypelearningObjectiveRequirementGenusTypea learning objective requirement genus type
Returnosid.course.requisite.LearningObjectiveRequirementListthe returned LearningObjectiveRequirementList
ErrorsNULL_ARGUMENT learningObjectiveRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveRequirementsByParentGenusType
Description

Gets a LearningObjectiveRequirementList corresponding to the given learning objective requirement genus Type and include any additional learning objective requirements with genus types derived from the specified Type.

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.

Parametersosid.type.TypelearningObjectiveRequirementGenusTypea learning objective requirements genus type
Returnosid.course.requisite.LearningObjectiveRequirementListthe returned LearningObjectiveRequirementList
ErrorsNULL_ARGUMENT learningObjectiveRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveRequirementsByRecordType
Description

Gets a LearningObjectiveRequirementList containing the given learning objective requirement record Type.

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.

Parametersosid.type.TypelearningObjectiveRequirementRecordTypea learning objective requirement record type
Returnosid.course.requisite.LearningObjectiveRequirementListthe returned LearningObjectiveRequirementList
ErrorsNULL_ARGUMENT learningObjectiverequirementRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveRequirementsByObjective
Description

Gets a LearningObjectiveRequirementList containing the given learning objective.

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.

Parametersosid.id.IdobjectiveIda learning objective Id
Returnosid.course.requisite.LearningObjectiveRequirementListthe returned LearningObjectiveRequirementList
ErrorsNULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveRequirementsByAltRequisite
Description

Gets a LearningObjectiveRequirementList with the given Requisite.

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.

Parametersosid.id.IdrequisiteIda requisite Id
Returnosid.course.requisite.LearningObjectiveRequirementListthe returned LearningObjectiveRequirementList
ErrorsNULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesForLearningObjectiveRequirement
Description

Gets a RequisiteList immediately containing the given learning objective requirement.

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.

Parametersosid.id.IdlearningObjectiveRequirementIda learning objective requirement Id
Returnosid.course.requisite.RequisiteListthe returned RequisiteList
ErrorsNULL_ARGUMENT learningObjectiveRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveRequirements
Description

Gets all LearningObjectiveRequirements.

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.

Returnosid.course.requisite.LearningObjectiveRequirementLista list of LearningObjectiveRequirements
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentRequirement
Description

Gets the AssessmentRequirement specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AssessmentRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to an AssessmentRequirement and retained for compatibility.

In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned.

Parametersosid.id.IdassessmentRequirementIdthe Id of the AssessmentRequirement to retrieve
Returnosid.course.requisite.AssessmentRequirementthe returned AssessmentRequirement
ErrorsNOT_FOUNDno AssessmentRequirement found with the given Id
NULL_ARGUMENT assessmentRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentRequirementsByIds
Description

Gets an AssessmentRequirementList corresponding to the given IdList.

In plenary mode, the returned list contains all of the assessment requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AssessmentlRequirements may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned.

Parametersosid.id.IdListassessmentRequirementIdsthe list of Ids to retrieve
Returnosid.course.requisite.AssessmentRequirementLista list of AssessmentRequirements
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT assessmentRequirementIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentRequirementsByGenusType
Description

Gets an AssessmentRequirementList corresponding to the given assessment requirement genus Type which does not include assessment requirements of types derived from the specified Type.

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.

Parametersosid.type.TypeassessmentRequirementGenusTypean assessment requirement genus type
Returnosid.course.requisite.AssessmentRequirementLista list of AssessmentRequirements
ErrorsNULL_ARGUMENT assessmentRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentRequirementsByParentGenusType
Description

Gets an AssessmentRequirementList corresponding to the given assessment requirement genus Type and include any additional assessment requirements with genus types derived from the specified Type.

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.

Parametersosid.type.TypeassessmentRequirementGenusTypean assessment requirements genus type
Returnosid.course.requisite.AssessmentRequirementLista list of AssessmentRequirements
ErrorsNULL_ARGUMENT assessmentRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentRequirementsByRecordType
Description

Gets an AssessmentRequirementList containing the given assessment requirement record Type.

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.

Parametersosid.type.TypeassessmentRequirementRecordTypean assessment requirement record type
Returnosid.course.requisite.AssessmentRequirementLista list of AssessmentRequirements
ErrorsNULL_ARGUMENT assessmentRequirementRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentRequirementsByAssessment
Description

Gets an AssessmentRequirementList containing the given assessment. 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.

Parametersosid.id.IdassessmentIdan assessment Id
Returnosid.course.requisite.AssessmentRequirementLista list of AssessmentRequirements
ErrorsNULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentRequirementsByAltRequisite
Description

Gets an AssessmentRequirementList with the given Requisite.

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.

Parametersosid.id.IdrequisiteIda requisite Id
Returnosid.course.requisite.AssessmentRequirementLista list of AssessmentRequirements
ErrorsNULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesForAssessmentRequirement
Description

Gets a RequisiteList immediately containing the given assessment requirement.

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.

Parametersosid.id.IdassessmentRequirementIdan assessment requirement Id
Returnosid.course.requisite.RequisiteLista list of Requisites
ErrorsNULL_ARGUMENT assessmentRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentRequirements
Description

Gets all AssessmentRequirements.

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.

Returnosid.course.requisite.AssessmentRequirementLista list of AssessmentRequirements
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardRequirement
Description

Gets the AwardRequirement specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AwardRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to an AwardRequirement and retained for compatibility.

In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned.

Parametersosid.id.IdawardRequirementIdthe Id of the AwardRequirement to retrieve
Returnosid.course.requisite.AwardRequirementthe returned AwardRequirement
ErrorsNOT_FOUNDno AwardRequirement found with the given Id
NULL_ARGUMENT awardRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardRequirementsByIds
Description

Gets an AwardRequirementList corresponding to the given IdList.

In plenary mode, the returned list contains all of the award requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AwardlRequirements may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned.

Parametersosid.id.IdListawardRequirementIdsthe list of Ids to retrieve
Returnosid.course.requisite.AwardRequirementLista list of AwardRequirements
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT awardRequirementIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardRequirementsByGenusType
Description

Gets an AwardRequirementList corresponding to the given award requirement genus Type which does not include award requirements of types derived from the specified Type.

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.

Parametersosid.type.TypeawardRequirementGenusTypean award requirement genus type
Returnosid.course.requisite.AwardRequirementLista list of AwardRequirements
ErrorsNULL_ARGUMENT awardRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardRequirementsByParentGenusType
Description

Gets an AwardRequirementList corresponding to the given award requirement genus Type and include any additional award requirements with genus types derived from the specified Type.

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.

Parametersosid.type.TypeawardRequirementGenusTypean award requirements genus type
Returnosid.course.requisite.AwardRequirementLista list of AwardRequirements
ErrorsNULL_ARGUMENT awardRequirementGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardRequirementsByRecordType
Description

Gets an AwardRequirementList containing the given award requirement record Type.

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.

Parametersosid.type.TypeawardRequirementRecordTypean award requirement record type
Returnosid.course.requisite.AwardRequirementLista list of AwardRequirements
ErrorsNULL_ARGUMENT awardRequirementRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardRequirementsByAward
Description

Gets an AwardRequirementList containing the given award.

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.

Parametersosid.id.IdawardIdan award Id
Returnosid.course.requisite.AwardRequirementLista list of AwardRequirements
ErrorsNULL_ARGUMENT awardId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardRequirementsByAltRequisite
Description

Gets an AwardRequirementList with the given Requisite.

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.

Parametersosid.id.IdrequisiteIda requisite Id
Returnosid.course.requisite.AwardRequirementLista list of AwardRequirements
ErrorsNULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequisitesForAwardRequirement
Description

Gets a RequisiteList immediately containing the given award requirement.

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.

Parametersosid.id.IdawardRequirementIdan award requirement Id
Returnosid.course.requisite.RequisiteLista list of Requisites
ErrorsNULL_ARGUMENT awardRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardRequirements
Description

Gets all AwardRequirements.

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.

Returnosid.course.requisite.AwardRequirementLista list of AwardRequirements
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.