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

This session creates and removes requisites and their requirement components. The data for create and update is provided via their respective forms.

The view of the administrative methods defined in this session is determined by the provider. For an instance of this session where no course catalog has been specified, it may not be parallel to the RequisiteLookupSession. For example, a default RequisiteLookupSession may view the entire course catalog hierarchy while the default RequisiteAdminSession uses an isolated CourseCatalog to create new Requisites or a specific course catalog to operate on a predetermined set of Requisites. Another scenario is a federated provider who does not wish to permit administrative operations for the federation unaware.

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.
MethodcanCreateRequisites
Description

Tests if this user can create Requisites. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Requisite will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if Requisite creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateRequisiteWithRecordTypes
Description

Tests if this user can create a single Porgram using the desired record types. While CourseRequisiteManager.getRequisiteRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Requisite. Providing an empty array tests if a Requisite can be created with no records.

Parametersosid.type.Type[]requisiteRecordTypesarray of requisite record types
Returnboolean true if Requisite creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT requisiteRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetRequisiteFormForCreate
Description

Gets the requisite form for creating new requisites. A new form should be requested for each create transaction.

Parametersosid.type.Type[]requisiteRecordTypesarray of requisite record types
Returnosid.course.requisite.RequisiteFormthe requisite form
ErrorsNULL_ARGUMENT requisiteRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateRequisite
Description

Creates a new Requisite.

Parametersosid.course.requisite.RequisiteFormrequisiteFormthe form for this Requisite
Returnosid.course.requisite.Requisitethe new Requisite
ErrorsILLEGAL_STATE requisiteForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT requisiteForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED requisiteForm did not originate from getRequisiteFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateRequisites
Description

Tests if this user can update Requisites. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a requisite will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if requisite modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRequisiteFormForUpdate
Description

Gets the requisite form for updating an existing requisite. A new requisite form should be requested for each update transaction.

Parametersosid.id.IdrequisiteIdthe Id of the Requisite
Returnosid.course.requisite.RequisiteFormthe requisite form
ErrorsNOT_FOUND requisiteId is not found
NULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRequisite
Description

Updates an existing requisite.

Parametersosid.course.requisite.RequisiteFormrequisiteFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE requisiteForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT requisiteId or requisiteForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED requisiteForm did not originate from getRequisiteFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteRequisites
Description

Tests if this user can delete Requisites. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Requisite will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if Requisite deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanDeleteRequisite
Description

Tests if this user can delete a specified Requisite. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the Requisite will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user for this requisite.

Parametersosid.id.IdrequisiteIdthe Id of the Requisite
Returnboolean false if deletion of this Requisite is not authorized, true otherwise
ErrorsNULL_ARGUMENT requisiteId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the requisiteId is not found, then it is acceptable to return false to indicate the lack of a delete available.

MethoddeleteRequisite
Description

Deletes a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of the Requisite to remove
ErrorsNOT_FOUND requisiteId not found
NULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageRequisiteAliases
Description

Tests if this user can manage Id aliases for Requisites. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if Requisite aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasRequisite
Description

Adds an Id to a Requisite for the purpose of creating compatibility. The primary Id of the Requisite is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another requisite, it is reassigned to the given requisite Id.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is in use as a primary Id
NOT_FOUND requisiteId not found
NULL_ARGUMENT requisiteId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddRequsiteOption
Description

Adds a Requisite as an option to a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdrequisiteOptionIdthe Id of a Requisite option
ErrorsALREADY_EXISTS requisiteOptionId is already part of requisiteId
NOT_FOUND requisiteId or requisiteOptionId not found
NULL_ARGUMENT requisiteId or requisiteOptionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRequsiteOption
Description

Removes a Requisite as an option from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdrequisiteOptionIdthe Id of a Requisite option
ErrorsNOT_FOUND requisiteId or requisiteOptionId not found or requisiteOptionId not part of requisiteId
NULL_ARGUMENT requisiteId or requisiteOptionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRequsiteOptions
Description

Removes all Requisites as options from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND requisiteId not found
NULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateCourseRequirements
Description

Tests if this user can create CourseRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a CourseRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if CourseRequirement creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateCourseRequirementWithRecordTypes
Description

Tests if this user can create a single CourseRequirement using the desired record types. While CourseRequisiteManager.getCourseRequirementRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific CourseRequirement. Providing an empty array tests if a CourseRequirement can be created with no records.

Parametersosid.type.Type[]courseRequirementRecordTypesarray of course requirement record types
Returnboolean true if CourseRequirement creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT courseRequirementRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetCourseRequirementFormForCreate
Description

Gets the course requirement form for creating new course requirements. A new form should be requested for each create transaction.

Parametersosid.id.IdcourseIdan Id of a Course
osid.type.Type[]courseRequirementRecordTypesarray of course requirement record types
Returnosid.course.requisite.CourseRequirementFormthe course requirement form
ErrorsNOT_FOUND courseId is not found
NULL_ARGUMENT courseId or courseRequirementRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateCourseRequirement
Description

Creates a new CourseRequirement.

Parametersosid.id.IdcourseIdan Id of a Course
osid.course.requisite.CourseRequirementFormcourseRequirementFormthe form for this CourseRequirement
Returnosid.course.requisite.CourseRequirementthe new CourseRequirement
ErrorsALREADY_EXISTSattempt at duplicating a property the underlying system is enforcing to be unique
INVALID_ARGUMENTone or more of the form elements is invalid
NOT_FOUND courseId is not found
NULL_ARGUMENT courseId or courseRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED courseRequirementForm is not of this service
CompliancemandatoryThis method must be implemented.
MethodcanUpdateCourseRequirements
Description

Tests if this user can update CourseRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a CourseRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if CourseRequirement modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanUpdateCourseRequirement
Description

Tests if this user can update a specified CourseRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating the CourseRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer an update operation to an unauthorized user for this CourseRequirement.

Parametersosid.id.IdcourseRequirementIdthe Id of the CourseRequirement
Returnboolean false if course requirement modification is not authorized, true otherwise
ErrorsNULL_ARGUMENT courseRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the courseRequirementId is not found, then it is acceptable to return false to indicate the lack of an update available.

MethodgetCourseRequirementFormForUpdate
Description

Gets the course requirement form for updating an existing course requirement. A new requisite form should be requested for each update transaction.

Parametersosid.id.IdcourseRequirementIdthe Id of the CourseRequirement
Returnosid.course.requisite.CourseRequirementFormthe course requirement form
ErrorsNOT_FOUND courseRequirementId is not found
NULL_ARGUMENT courseRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCourseRequirement
Description

Updates an existing course requirement.

Parametersosid.id.IdcourseRequirementIdthe Id of the CourseRequirement
osid.course.requisite.CourseRequirementFormcourseRequirementFormthe form containing the elements to be updated
ErrorsINVALID_ARGUMENTthe form contains an invalid value
NOT_FOUND courseRequirementId is not found
NULL_ARGUMENT courseRequirementId or courseRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED courseRequirementForm is not supported
CompliancemandatoryThis method must be implemented.
MethodcanDeleteCourseRequirements
Description

Tests if this user can delete CourseRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a CourseRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if CourseRequirement deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanDeleteCourseRequirement
Description

Tests if this user can delete a specified CourseRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the CourseRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user for this course requirement.

Parametersosid.id.IdcourseRequirementIdthe Id of the CourseRequirement
Returnboolean false if deletion of this CourseRequirement is not authorized, true otherwise
ErrorsNULL_ARGUMENT courseRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the courseRequirementId, is not found, then it is acceptable to return false to indicate the lack of a delete available.

MethoddeleteCourseRequirement
Description

Deletes a CourseRequirement.

Parametersosid.id.IdcourseRequirementIdthe Id of the CourseRequirement to remove
ErrorsNOT_FOUND courseRequirementId not found
NULL_ARGUMENT courseRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCourseRequirements
Description

Deletes all CourseRequirements in this CourseCatalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageCourseRequirementAliases
Description

Tests if this user can manage Id aliases for CourseRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if CourseRequirement aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasCourseRequirement
Description

Adds an Id to a CourseRequirement for the purpose of creating compatibility. The primary Id of the CourseRequirement is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another course requirement, it is reassigned to the given course requirement Id.

Parametersosid.id.IdcourseRequirementIdthe Id of a CourseRequirement
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is in use as a primary Id
NOT_FOUND courseRequirementId not found
NULL_ARGUMENT courseRequirementId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddCourseRequirement
Description

Adds a CourseRequirement to a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdcourseRequirementIdthe Id of a CourseRequirement
ErrorsALREADY_EXISTS courseRequirementId is already part of requisiteId
NOT_FOUND requisiteId or courseRequirementId not found
NULL_ARGUMENT requisiteId or courseRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveCourseRequirement
Description

Removes a CourseRequirement from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdcourseRequirementIdthe Id of a CourseRequirement
ErrorsNOT_FOUND requisiteId or courseRequirementId not found or courseRequirementId not part of requisiteId
NULL_ARGUMENT requisiteId or courseRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveCourseRequirements
Description

Removes all CourseRequirements from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND requisiteId not found
NULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddAltRequisiteToCourseRequirement
Description

Adds an alternative Requisite to a CourseRequirement.

Parametersosid.id.IdcourseRequirementIdthe Id of a CourseRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsALREADY_EXISTS requisiteId is already part of courseRequirementId
NOT_FOUND courseRequirementId or requisiteId not found
NULL_ARGUMENT courseRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisiteFromCourseRequirement
Description

Removes an alternative Requisite from a CourseRequirement.

Parametersosid.id.IdcourseRequirementIdthe Id of a CourseRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND courseRequirementId or requisiteId not found or requisiteId not part of courseRequirementId
NULL_ARGUMENT courseRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisitesFromCourseRequirement
Description

Removes all Requisites from a CourseRequirement.

Parametersosid.id.IdcourseRequirementIdthe Id of a CourseRequirement
ErrorsNOT_FOUND courseRequirementId not found
NULL_ARGUMENT courseRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateProgramRequirements
Description

Tests if this user can create ProgramRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a ProgramRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if ProgramRequirement creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateProgramRequirementWithRecordTypes
Description

Tests if this user can create a single ProgramRequirement using the desired record types. While CourseRequisiteManager.getProgramRequirementRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific ProgramRequirement. Providing an empty array tests if a ProgramRequirement can be created with no records.

Parametersosid.type.Type[]programRequirementRecordTypesarray of program requirement record types
Returnboolean true if ProgramRequirement creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT programRequirementRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetProgramRequirementFormForCreate
Description

Gets the program requirement form for creating new program requirements. A new form should be requested for each create transaction.

Parametersosid.id.IdprogramIdan Id of a program
osid.type.Type[]programRequirementRecordTypesarray of program requirement record types
Returnosid.course.requisite.ProgramRequirementFormthe program requirement form
ErrorsNOT_FOUND programId is not found
NULL_ARGUMENT programRequirementRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateProgramRequirement
Description

Creates a new ProgramRequirement.

Parametersosid.id.IdprogramIdan Id of a program
osid.course.requisite.ProgramRequirementFormprogramRequirementFormthe form for this ProgramRequirement
Returnosid.course.requisite.ProgramRequirementthe new ProgramRequirement
ErrorsALREADY_EXISTSattempt at duplicating a property the underlying system is enforcing to be unique
INVALID_ARGUMENTone or more of the form elements is invalid
NOT_FOUND programId is not found
NULL_ARGUMENT programId or programRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED programRequirementForm is not of this service
CompliancemandatoryThis method must be implemented.
MethodcanUpdateProgramRequirements
Description

Tests if this user can update ProgramRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a ProgramRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if ProgramRequirement modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanUpdateProgramRequirement
Description

Tests if this user can update a specified ProgramRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating the ProgramRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer an update operation to an unauthorized user for this ProgramRequirement.

Parametersosid.id.IdprogramRequirementIdthe Id of the ProgramRequirement
Returnboolean false if program requirement modification is not authorized, true otherwise
ErrorsNULL_ARGUMENT programRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the programRequirementId is not found, then it is acceptable to return false to indicate the lack of an update available.

MethodgetProgramRequirementFormForUpdate
Description

Gets the program requirement form for updating an existing program requirement. A new requisite form should be requested for each update transaction.

Parametersosid.id.IdprogramRequirementIdthe Id of the ProgramRequirement
Returnosid.course.requisite.ProgramRequirementFormthe program requirement form
ErrorsNOT_FOUND programRequirementId is not found
NULL_ARGUMENT programRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProgramRequirement
Description

Updates an existing program requirement.

Parametersosid.id.IdprogramRequirementIdthe Id of the ProgramRequirement
osid.course.requisite.ProgramRequirementFormprogramRequirementFormthe form containing the elements to be updated
ErrorsINVALID_ARGUMENTthe form contains an invalid value
NOT_FOUND programRequirementId is not found
NULL_ARGUMENT programRequirementId or programRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED programRequirementForm is not supported
CompliancemandatoryThis method must be implemented.
MethodcanDeleteProgramRequirements
Description

Tests if this user can delete ProgramRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a ProgramRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if ProgramRequirement deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanDeleteProgramRequirement
Description

Tests if this user can delete a specified ProgramRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the ProgramRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user for this program requirement.

Parametersosid.id.IdprogramRequirementIdthe Id of the ProgramRequirement
Returnboolean false if deletion of this ProgramRequirement is not authorized, true otherwise
ErrorsNULL_ARGUMENT programRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the programRequirementId, is not found, then it is acceptable to return false to indicate the lack of a delete available.

MethoddeleteProgramRequirement
Description

Deletes a ProgramRequirement.

Parametersosid.id.IdprogramRequirementIdthe Id of the ProgramRequirement to remove
ErrorsNOT_FOUND programRequirementId not found
NULL_ARGUMENT programRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteProgramRequirements
Description

Deletes all ProgramRequirements in this CourseCatalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageProgramRequirementAliases
Description

Tests if this user can manage Id aliases for ProgramRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if ProgramRequirement aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasProgramRequirement
Description

Adds an Id to a ProgramRequirement for the purpose of creating compatibility. The primary Id of the ProgramRequirement is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another program requirement, it is reassigned to the given program requirement Id.

Parametersosid.id.IdprogramRequirementIdthe Id of a ProgramRequirement
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is in use as a primary Id
NOT_FOUND programRequirementId not found
NULL_ARGUMENT programRequirementId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddProgramRequirement
Description

Adds a ProgramRequirement to a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdprogramRequirementIdthe Id of a ProgramRequirement
ErrorsALREADY_EXISTS programRequirementId is already part of requisiteId
NOT_FOUND requisiteId or programRequirementId not found
NULL_ARGUMENT requisiteId or programRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveProgramRequirement
Description

Removes a ProgramRequirement from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdprogramRequirementIdthe Id of a ProgramRequirement
ErrorsNOT_FOUND requisiteId or programRequirementId not found or programRequirementId not part of requisiteId
NULL_ARGUMENT requisiteId or programRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveProgramRequirements
Description

Removes all ProgramRequirements from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND requisiteId not found
NULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddAltRequisiteToProgramRequirement
Description

Adds an alternative Requisite to a ProgramRequirement.

Parametersosid.id.IdprogramRequirementIdthe Id of a ProgramRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsALREADY_EXISTS requisiteId is already part of programRequirementId
NOT_FOUND programRequirementId or requisiteId not found
NULL_ARGUMENT programRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisiteFromProgramRequirement
Description

Removes an alternative Requisite from a ProgramRequirement.

Parametersosid.id.IdprogramRequirementIdthe Id of a ProgramRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND programRequirementId or requisiteId not found or requisiteId not part of programRequirementId
NULL_ARGUMENT programRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisitesFromProgramRequirement
Description

Removes all Requisites from a ProgramRequirement.

Parametersosid.id.IdprogramRequirementIdthe Id of a ProgramRequirement
ErrorsNOT_FOUND programRequirementId not found
NULL_ARGUMENT programRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateCredentialRequirements
Description

Tests if this user can create CredentialRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a CredentialRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if CredentialRequirement creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateCredentiaRequirementWithRecordTypes
Description

Tests if this user can create a single CredentialRequirement using the desired record types. While CourseRequisiteManager.getCredentialRequirementRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific CredentialRequirement. Providing an empty array tests if a CredentialRequirement can be created with no records.

Parametersosid.type.Type[]credentialRequirementRecordTypesarray of credential requirement record types
Returnboolean true if CredentialRequirement creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT credentialRequirementRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetCredentialRequirementFormForCreate
Description

Gets the credential requirement form for creating new credential requirements. A new form should be requested for each create transaction.

Parametersosid.id.IdcredentialIda credential Id
osid.type.Type[]credentialRequirementRecordTypesarray of credential requirement record types
Returnosid.course.requisite.CredentialRequirementFormthe credential requirement form
ErrorsNOT_FOUND credentialId is not found
NULL_ARGUMENT credentialId or credentialRequirementRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateCredentialRequirement
Description

Creates a new CredentialRequirement.

Parametersosid.id.IdcredentialIda credential Id
osid.course.requisite.CredentialRequirementFormcredentialRequirementFormthe form for this CredentialRequirement
Returnosid.course.requisite.CredentialRequirementthe new CredentialRequirement
ErrorsALREADY_EXISTSattempt at duplicating a property the underlying system is enforcing to be unique
INVALID_ARGUMENTone or more of the form elements is invalid
NOT_FOUND credentialId is not found
NULL_ARGUMENT credentialId or credentialRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED credentialRequirementForm is not of this service
CompliancemandatoryThis method must be implemented.
MethodcanUpdateCredentialRequirements
Description

Tests if this user can update CredentialRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a CredentialRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if CredentialRequirement modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanUpdateCredentialRequirement
Description

Tests if this user can update a specified CredentialRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating the CredentialRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer an update operation to an unauthorized user for this CredentialRequirement.

Parametersosid.id.IdcredentialRequirementIdthe Id of the CredentialRequirement
Returnboolean false if credential requirement modification is not authorized, true otherwise
ErrorsNULL_ARGUMENT credentialRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the credentialRequirementId is not found, then it is acceptable to return false to indicate the lack of an update available.

MethodgetCredentialRequirementFormForUpdate
Description

Gets the credential requirement form for updating an existing credential requirement. A new requisite form should be requested for each update transaction.

Parametersosid.id.IdcredentialRequirementIdthe Id of the CredentialRequirement
Returnosid.course.requisite.CredentialRequirementFormthe credential requirement form
ErrorsNOT_FOUND credentialRequirementId is not found
NULL_ARGUMENT credentialRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateCredentialRequirement
Description

Updates an existing credential requirement.

Parametersosid.id.IdcredentialRequirementIdthe Id of the CredentialRequirement
osid.course.requisite.CredentialRequirementFormcredentialRequirementFormthe form containing the elements to be updated
ErrorsINVALID_ARGUMENTthe form contains an invalid value
NOT_FOUND credentialRequirementId is not found
NULL_ARGUMENT credentialRequirementId or credentialRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED credentialRequirementForm is not supported
CompliancemandatoryThis method must be implemented.
MethodcanDeleteCredentialRequirements
Description

Tests if this user can delete CredentialRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a CredentialRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if CredentialRequirement deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanDeleteCredentialRequirement
Description

Tests if this user can delete a specified CredentialRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the CredentialRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user for this credential requirement.

Parametersosid.id.IdcredentialRequirementIdthe Id of the CredentialRequirement
Returnboolean false if deletion of this CredentialRequirement is not authorized, true otherwise
ErrorsNULL_ARGUMENT credentialRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the credentialRequirementId, is not found, then it is acceptable to return false to indicate the lack of a delete available.

MethoddeleteCredentialRequirement
Description

Deletes a CredentialRequirement.

Parametersosid.id.IdcredentialRequirementIdthe Id of the CredentialRequirement to remove
ErrorsNOT_FOUND credentialRequirementId not found
NULL_ARGUMENT credentialRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteCredentialRequirements
Description

Deletes all CredentialRequirements in this CourseCatalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageCredentialRequirementAliases
Description

Tests if this user can manage Id aliases for CredentialRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if CredentialRequirement aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasCredentialRequirement
Description

Adds an Id to a CredentialRequirement for the purpose of creating compatibility. The primary Id of the CredentialRequirement is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another credential requirement, it is reassigned to the given credential requirement Id.

Parametersosid.id.IdcredentialRequirementIdthe Id of a CredentialRequirement
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is in use as a primary Id
NOT_FOUND credentialRequirementId not found
NULL_ARGUMENT credentialRequirementId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddCredentialRequirement
Description

Adds a CredentialRequirement to a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdcredentialRequirementIdthe Id of a CredentialRequirement
ErrorsALREADY_EXISTS credentialRequirementId is already part of requisiteId
NOT_FOUND requisiteId or credentialRequirementId not found
NULL_ARGUMENT requisiteId or credentialRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveCredentialRequirement
Description

Removes a CredentialRequirement from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdcredentialRequirementIdthe Id of a CredentialRequirement
ErrorsNOT_FOUND requisiteId or credentialRequirementId not found or credentialRequirementId not part of requisiteId
NULL_ARGUMENT requisiteId or credentialRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveCredentialRequirements
Description

Removes all CredentialRequirements from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND requisiteId not found
NULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddAltRequisiteToCredentialRequirement
Description

Adds an alternative Requisite to a CredentialRequirement.

Parametersosid.id.IdcredentialRequirementIdthe Id of a CredentialRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsALREADY_EXISTS requisiteId is already part of credentialRequirementId
NOT_FOUND credentialRequirementId or requisiteId not found
NULL_ARGUMENT credentialRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisiteFromCredentialRequirement
Description

Removes an alternative Requisite from a CredentialRequirement.

Parametersosid.id.IdcredentialRequirementIdthe Id of a CredentialRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND credentialRequirementId or requisiteId not found or requisiteId not part of credentialRequirementId
NULL_ARGUMENT credentialRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisitesFromCredentialRequirement
Description

Removes all Requisites from a CredentialRequirement.

Parametersosid.id.IdcredentialRequirementIdthe Id of a CredentialRequirement
ErrorsNOT_FOUND credentialRequirementId not found
NULL_ARGUMENT credentialRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateLearningObjectiveRequirements
Description

Tests if this user can create LearningObjectiveRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a LearningObjectiveRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if LearningObjectiveRequirement creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateLearningObjectiveRequirementWithRecordTypes
Description

Tests if this user can create a single LearningObjectiveRequirement using the desired record types. While CourseRequisiteManager.getLearningObjectiveRequirementRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific LearningObjectiveRequirement. Providing an empty array tests if a LearningObjectiveRequirement can be created with no records.

Parametersosid.type.Type[]learningObjectiveRequirementRecordTypesarray of learning objective requirement record types
Returnboolean true if LearningObjectiveRequirement creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT learningObjectiveRequirementRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetLearningObjectiveRequirementFormForCreate
Description

Gets the learning objective requirement form for creating new learning objective requirements. A new form should be requested for each create transaction.

Parametersosid.id.IdobjectiveIda learning objective Id
osid.type.Type[]learningObjectiveRequirementFormarray of learning objective requirement record types
Returnosid.course.requisite.LearningObjectiveRequirementFormthe learning objective requirement form
ErrorsNOT_FOUND objectiveId is not found
NULL_ARGUMENT objectiveId or learningObjectiveRequirementRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateLearningObjectiveRequirement
Description

Creates a new LearningObjectiveRequirement.

Parametersosid.id.IdobjectiveIda learning objective Id
osid.course.requisite.LearningObjectiveRequirementFormlearningObjectiveRequirementFormthe form for this LearningObjectiveRequirement
Returnosid.course.requisite.LearningObjectiveRequirementthe new LearningObjectiveRequirement
ErrorsALREADY_EXISTSattempt at duplicating a property the underlying system is enforcing to be unique
INVALID_ARGUMENTone or more of the form elements is invalid
NOT_FOUND objectiveId is not found
NULL_ARGUMENT objectiveId or learningObjectiveRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED learningObjectiveRequirementForm is not of this service
CompliancemandatoryThis method must be implemented.
MethodcanUpdateLearningObjectiveRequirements
Description

Tests if this user can update LearningObjectiveRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a LearningObjectiveRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if LearningObjectiveRequirement modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanUpdateLearningObjectiveRequirement
Description

Tests if this user can update a specified LearningObjectiveRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating the LearningObjectiveRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer an update operation to an unauthorized user for this LearningObjectiveRequirement.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of the LearningObjectiveRequirement
Returnboolean false if learning objective requirement modification is not authorized, true otherwise
ErrorsNULL_ARGUMENT learningObjectiveRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the learningObjectiveRequirementRequirementId is not found, then it is acceptable to return false to indicate the lack of an update available.

MethodgetLearningObjectiveRequirementFormForUpdate
Description

Gets the learning objective requirement form for updating an existing learning objective requirement. A new requisite form should be requested for each update transaction.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of the LearningObjectiveRequirement
Returnosid.course.requisite.LearningObjectiveRequirementFormthe learning objective requirement form
ErrorsNOT_FOUND learningObjectiveRequirementId is not found
NULL_ARGUMENT learningObjectiveRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateLearningObjectiveRequirement
Description

Updates an existing learning objective requirement.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of the LearningObjectiveRequirement
osid.course.requisite.LearningObjectiveRequirementFormlearningObjectiveRequirementFormthe form containing the elements to be updated
ErrorsINVALID_ARGUMENTthe form contains an invalid value
NOT_FOUND learningObjectiveRequirementId is not found
NULL_ARGUMENT learningObjectiveRequirementId or learningObjectiveRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED learningObjectiveRequirementForm is not supported
CompliancemandatoryThis method must be implemented.
MethodcanDeleteLearningObjectiveRequirements
Description

Tests if this user can delete LearningObjectiveRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a LearningObjectiveRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if LearningObjectiveRequirement deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanDeleteLearningObjectiveRequirement
Description

Tests if this user can delete a specified LearningObjectiveRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the LearningObjectiveRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user for this learning objective requirement.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of the LearningObjectiveRequirement
Returnboolean false if deletion of this LearningObjectiveRequirement is not authorized, true otherwise
ErrorsNULL_ARGUMENT learningObjectiveRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the learningObjectiveRequirementId, is not found, then it is acceptable to return false to indicate the lack of a delete available.

MethoddeleteLearningObjectiveRequirement
Description

Deletes a LearningObjectiveRequirement.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of the LearningObjectiveRequirement to remove
ErrorsNOT_FOUND learningObjectiveRequirementId not found
NULL_ARGUMENT learningObjectiveRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteLearningObjectiveRequirements
Description

Deletes all LearningObjectiveRequirements in this CourseCatalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageLearningObjectiveRequirementAliases
Description

Tests if this user can manage Id aliases for LearningObjectiveRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if LearningObjectiveRequirement aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasLearningObjectiveRequirement
Description

Adds an Id to a LearningObjectiveRequirement for the purpose of creating compatibility. The primary Id of the LearningObjectiveRequirement is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another credential requirement, it is reassigned to the given learning objective requirement Id.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of a LearningObjectiveRequirement
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is in use as a primary Id
NOT_FOUND learningObjectiveRequirementId not found
NULL_ARGUMENT learningObjectiveRequirementId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddLearningObjectiveRequirement
Description

Adds a LearningObjectiveRequirement to a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdlearningObjectiveRequirementIdthe Id of a LearningObjectiveRequirement
ErrorsALREADY_EXISTS learningObjectiveRequirementId is already part of requisiteId
NOT_FOUND requisiteId or learningObjectiveRequirementId not found
NULL_ARGUMENT requisiteId or learningObjectiveRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveLearningObjectiveRequirement
Description

Removes a LearningObjectiveRequirement from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdlearningObjectiveRequirementIdthe Id of a LearningObjectiveRequirement
ErrorsNOT_FOUND requisiteId or learningObjectiveRequirementId not found or learningObjectiveRequirementId not part of requisiteId
NULL_ARGUMENT requisiteId or credentialRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveLearningObjectiveRequirements
Description

Removes all LearningObjectiveRequirements from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND requisiteId not found
NULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddAltRequisiteToLearningObjectiveRequirement
Description

Adds an alternative Requisite to a LearningObjectiveRequirement.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of a LearningObjectiveRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsALREADY_EXISTS requisiteId is already part of learningObjectiveRequirementId
NOT_FOUND learningObjectiveRequirementId or requisiteId not found
NULL_ARGUMENT learningObjectiveRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisiteFromLearningObjectiveRequirement
Description

Removes an alternative Requisite from a LearningObjectiveRequirement.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of a LearningObjectiveRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND learningObjectiveRequirementId or requisiteId not found or requisiteId not part of learningObjectiveRequirementId
NULL_ARGUMENT learningObjectiveRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisitesFromLearningObjectiveRequirement
Description

Removes all Requisites from a LearningObjectiveRequirement.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of a LearningObjectiveRequirement
ErrorsNOT_FOUND learningObjectiveRequirementId not found
NULL_ARGUMENT learningObjectiveRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateAssessmentRequirements
Description

Tests if this user can create AssessmentRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an AssessmentRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if AssessmentRequirement creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateAssessmentRequirementWithRecordTypes
Description

Tests if this user can create a single AssessmentRequirement using the desired record types. While CourseRequisiteManager.getAssessmentRequirementRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific AssessmentRequirement. Providing an empty array tests if an AssessmentRequirement can be created with no records.

Parametersosid.type.Type[]assessmentRequirementRecordTypesarray of assessment requirement record types
Returnboolean true if AssessmentRequirement creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT assessmentRequirementRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentRequirementFormForCreate
Description

Gets the assessment requirement form for creating new credential requirements. A new form should be requested for each create transaction.

Parametersosid.id.IdassessmentIda assessment Id
osid.type.Type[]assessmentRequirementRecordTypesarray of assessment requirement record types
Returnosid.course.requisite.AssessmentRequirementFormthe assessment requirement form
ErrorsNOT_FOUND assessmentId is not found
NULL_ARGUMENT assessmentId or assessmentRequirementRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAssessmentRequirement
Description

Creates a new AssessmentRequirement.

Parametersosid.id.IdassessmentIdan assessment Id
osid.course.requisite.AssessmentRequirementFormassessmentRequirementFormthe form for this AssessmentRequirement
Returnosid.course.requisite.AssessmentRequirementthe new AssessmentRequirement
ErrorsALREADY_EXISTSattempt at duplicating a property the underlying system is enforcing to be unique
INVALID_ARGUMENTone or more of the form elements is invalid
NOT_FOUND assessmentId is not found
NULL_ARGUMENT assessmentid or assessmentRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED assessmentRequirementForm is not of this service
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAssessmentRequirements
Description

Tests if this user can update AssessmentRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AssessmentRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if AssessmentRequirement modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAssessmentRequirement
Description

Tests if this user can update a specified AssessmentRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating the AssessmentRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer an update operation to an unauthorized user for this AssessmentRequirement.

Parametersosid.id.IdassessmentRequirementIdthe Id of the AssessmentRequirement
Returnboolean false if assessment requirement modification is not authorized, true otherwise
ErrorsNULL_ARGUMENT assessmentRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the assessmentRequirementId is not found, then it is acceptable to return false to indicate the lack of an update available.

MethodgetAssessmentRequirementFormForUpdate
Description

Gets the assessment requirement form for updating an existing credential requirement. A new requisite form should be requested for each update transaction.

Parametersosid.id.IdassessmentRequirementIdthe Id of the AssessmentRequirement
Returnosid.course.requisite.AssessmentRequirementFormthe assessment requirement form
ErrorsNOT_FOUND assessmentRequirementId is not found
NULL_ARGUMENT assessmentRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAssessmentRequirement
Description

Updates an existing assessment requirement.

Parametersosid.id.IdassessmentRequirementIdthe Id of the AssessmentRequirement
osid.course.requisite.AssessmentRequirementFormassessmentRequirementFormthe form containing the elements to be updated
ErrorsINVALID_ARGUMENTthe form contains an invalid value
NOT_FOUND assessmentRequirementId is not found
NULL_ARGUMENT assessmentRequirementId or assessmentRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED assessmentRequirementForm is not supported
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAssessmentRequirements
Description

Tests if this user can delete AssessmentRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AssessmentRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if AssessmentRequirement deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAssessmentRequirement
Description

Tests if this user can delete a specified AssessmentRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the AssessmentRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user for this assessment requirement.

Parametersosid.id.IdassessmentRequirementIdthe Id of the AssessmentRequirement
Returnboolean false if deletion of this AssessmentRequirement is not authorized, true otherwise
ErrorsNULL_ARGUMENT assessmentRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the assessmentRequirementId, is not found, then it is acceptable to return false to indicate the lack of a delete available.

MethoddeleteAssessmentRequirement
Description

Deletes an AssessmentRequirement.

Parametersosid.id.IdassessmentRequirementIdthe Id of the AssessmentRequirement to remove
ErrorsNOT_FOUND assessmentRequirementId not found
NULL_ARGUMENT assessmentRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAssessmentRequirements
Description

Deletes all AssessmentRequirements in this CourseCatalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAssessmentRequirementAliases
Description

Tests if this user can manage Id aliases for AssessmentRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if AssessmentRequirement aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAssessmentRequirement
Description

Adds an Id to an AssessmentRequirement for the purpose of creating compatibility. The primary Id of the AssessmentRequirement is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another assessment requirement, it is reassigned to the given assessment requirement Id.

Parametersosid.id.IdassessmentRequirementIdthe Id of an AssessmentRequirement
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is in use as a primary Id
NOT_FOUND assessmentRequirementId not found
NULL_ARGUMENT assessmentRequirementId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddAssessmentRequirement
Description

Adds an AssessmentRequirement to a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdassessmentRequirementIdthe Id of an AssessmentRequirement
ErrorsALREADY_EXISTS assessmentRequirementId is already part of requisiteId
NOT_FOUND requisiteId or assessmentRequirementId not found
NULL_ARGUMENT requisiteId or assessmentRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAssessmentRequirement
Description

Removes anAssessment Requirement from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdassessmentRequirementIdthe Id of an AssessmentRequirement
ErrorsNOT_FOUND requisiteId or assessmentRequirementId not found or assessmentRequirementId not part of requisiteId
NULL_ARGUMENT requisiteId or assessmentRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAssessmentRequirements
Description

Removes all AssessmentRequirements from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND requisiteId not found
NULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddAltRequisiteToAssessmentRequirement
Description

Adds an alternative Requisite to an AssessmentRequirement.

Parametersosid.id.IdassessmentRequirementIdthe Id of an AssessmentRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsALREADY_EXISTS requisiteId is already part of assessmentRequirementId
NOT_FOUND assessmentRequirementId or requisiteId not found
NULL_ARGUMENT assessmentRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisiteFromAssessmentRequirement
Description

Removes an alternative Requisite from an AssessmentRequirement.

Parametersosid.id.IdassessmentRequirementIdthe Id of an AssessmentRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND assessmentRequirementId or requisiteId not found or requisiteId not part of assessmentRequirementId
NULL_ARGUMENT assessmentRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisitesFromAssessmentRequirement
Description

Removes all Requisites from an AssessmentRequirement.

Parametersosid.id.IdassessmentRequirementIdthe Id of an AssessmentRequirement
ErrorsNOT_FOUND assessmentRequirementId not found
NULL_ARGUMENT assessmentRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateAwardRequirements
Description

Tests if this user can create AwardRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an AwardRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if AwardRequirement creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateAwardRequirementWithRecordTypes
Description

Tests if this user can create a single AwardRequirement using the desired record types. While CourseRequisiteManager.getAwardRequirementRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific AwardRequirement. Providing an empty array tests if an AwardRequirement can be created with no records.

Parametersosid.type.Type[]awardRequirementRecordTypesarray of award requirement record types
Returnboolean true if AwardRequirement creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT awardRequirementRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAwardRequirementFormForCreate
Description

Gets the award requirement form for creating new credential requirements. A new form should be requested for each create transaction.

Parametersosid.id.IdawardIda award Id
osid.type.Type[]awardRequirementRecordTypesarray of award requirement record types
Returnosid.course.requisite.AwardRequirementFormthe award requirement form
ErrorsNOT_FOUND awardId is not found
NULL_ARGUMENT awardId or awardRequirementRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAwardRequirement
Description

Creates a new AwardRequirement.

Parametersosid.id.IdawardIdan award Id
osid.course.requisite.AwardRequirementFormawardRequirementFormthe form for this AwardRequirement
Returnosid.course.requisite.AwardRequirementthe new AwardRequirement
ErrorsALREADY_EXISTSattempt at duplicating a property the underlying system is enforcing to be unique
INVALID_ARGUMENTone or more of the form elements is invalid
NOT_FOUND awardId is not found
NULL_ARGUMENT awardid or awardRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED awardRequirementForm is not of this service
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAwardRequirements
Description

Tests if this user can update AwardRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AwardRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if AwardRequirement modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAwardRequirement
Description

Tests if this user can update a specified AwardRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating the AwardRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer an update operation to an unauthorized user for this AwardRequirement.

Parametersosid.id.IdawardRequirementIdthe Id of the AwardRequirement
Returnboolean false if award requirement modification is not authorized, true otherwise
ErrorsNULL_ARGUMENT awardRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the awardRequirementId is not found, then it is acceptable to return false to indicate the lack of an update available.

MethodgetAwardRequirementFormForUpdate
Description

Gets the award requirement form for updating an existing credential requirement. A new requisite form should be requested for each update transaction.

Parametersosid.id.IdawardRequirementIdthe Id of the AwardRequirement
Returnosid.course.requisite.AwardRequirementFormthe award requirement form
ErrorsNOT_FOUND awardRequirementId is not found
NULL_ARGUMENT awardRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAwardRequirement
Description

Updates an existing award requirement.

Parametersosid.id.IdawardRequirementIdthe Id of the AwardRequirement
osid.course.requisite.AwardRequirementFormawardRequirementFormthe form containing the elements to be updated
ErrorsINVALID_ARGUMENTthe form contains an invalid value
NOT_FOUND awardRequirementId is not found
NULL_ARGUMENT awardRequirementId or awardRequirementForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED awardRequirementForm is not supported
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAwardRequirements
Description

Tests if this user can delete AwardRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AwardRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if AwardRequirement deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAwardRequirement
Description

Tests if this user can delete a specified AwardRequirement. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the AwardRequirement will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user for this award requirement.

Parametersosid.id.IdawardRequirementIdthe Id of the AwardRequirement
Returnboolean false if deletion of this AwardRequirement is not authorized, true otherwise
ErrorsNULL_ARGUMENT awardRequirementId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the awardRequirementId, is not found, then it is acceptable to return false to indicate the lack of a delete available.

MethoddeleteAwardRequirement
Description

Deletes an AwardRequirement.

Parametersosid.id.IdawardRequirementIdthe Id of the AwardRequirement to remove
ErrorsNOT_FOUND awardRequirementId not found
NULL_ARGUMENT awardRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAwardRequirements
Description

Deletes all AwardRequirements in this CourseCatalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAwardRequirementAliases
Description

Tests if this user can manage Id aliases for AwardRequirements. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if AwardRequirement aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAwardRequirement
Description

Adds an Id to an AwardRequirement for the purpose of creating compatibility. The primary Id of the AwardRequirement is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another award requirement, it is reassigned to the given award requirement Id.

Parametersosid.id.IdawardRequirementIdthe Id of an AwardRequirement
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is in use as a primary Id
NOT_FOUND awardRequirementId not found
NULL_ARGUMENT awardRequirementId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddAwardRequirement
Description

Adds an AwardRequirement to a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdawardRequirementIdthe Id of an AwardRequirement
ErrorsALREADY_EXISTS awardRequirementId is already part of requisiteId
NOT_FOUND requisiteId or awardRequirementId not found
NULL_ARGUMENT requisiteId or awardRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAwardRequirement
Description

Removes anAward Requirement from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
osid.id.IdawardRequirementIdthe Id of an AwardRequirement
ErrorsNOT_FOUND requisiteId or awardRequirementId not found or awardRequirementId not part of requisiteId
NULL_ARGUMENT requisiteId or awardRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAwardRequirements
Description

Removes all AwardRequirements from a Requisite.

Parametersosid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND requisiteId not found
NULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddAltRequisiteToAwardRequirement
Description

Adds an alternative Requisite to an AwardRequirement.

Parametersosid.id.IdawardRequirementIdthe Id of an AwardRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsALREADY_EXISTS requisiteId is already part of awardRequirementId
NOT_FOUND awardRequirementId or requisiteId not found
NULL_ARGUMENT awardRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisiteFromAwardRequirement
Description

Removes an alternative Requisite from an AwardRequirement.

Parametersosid.id.IdawardRequirementIdthe Id of an AwardRequirement
osid.id.IdrequisiteIdthe Id of a Requisite
ErrorsNOT_FOUND awardRequirementId or requisiteId not found or requisiteId not part of awardRequirementId
NULL_ARGUMENT awardRequirementId or requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveAltRequisitesFromAwardRequirement
Description

Removes all Requisites from an AwardRequirement.

Parametersosid.id.IdawardRequirementIdthe Id of an AwardRequirement
ErrorsNOT_FOUND awardRequirementId not found
NULL_ARGUMENT awardRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.