Interface | osid.course.requisite.RequisiteAdminSession | ||
---|---|---|---|
Implements | osid.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 | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRequisites | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Requisite creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRequisiteWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | requisiteRecordTypes | array of requisite record types |
Return | boolean | true if Requisite creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | requisiteRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequisiteFormForCreate | ||
Description |
Gets the requisite form for creating new requisites. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | requisiteRecordTypes | array of requisite record types |
Return | osid.course.requisite.RequisiteForm | the requisite form | |
Errors | NULL_ARGUMENT | requisiteRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createRequisite | ||
Description |
Creates a new | ||
Parameters | osid.course.requisite.RequisiteForm | requisiteForm | the form for this Requisite |
Return | osid.course.requisite.Requisite | the new Requisite | |
Errors | ILLEGAL_STATE | requisiteForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | requisiteForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | requisiteForm did not originate from
getRequisiteFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRequisites | ||
Description |
Tests if this user can update | ||
Return | boolean | false if requisite modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequisiteFormForUpdate | ||
Description |
Gets the requisite form for updating an existing requisite. A new requisite form should be requested for each update transaction. | ||
Parameters | osid.id.Id | requisiteId | the Id of the Requisite |
Return | osid.course.requisite.RequisiteForm | the requisite form | |
Errors | NOT_FOUND | requisiteId is not found | |
NULL_ARGUMENT | requisiteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRequisite | ||
Description |
Updates an existing requisite. | ||
Parameters | osid.course.requisite.RequisiteForm | requisiteForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | requisiteForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | requisiteId or requisiteForm is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | requisiteForm did not originate from
getRequisiteFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRequisites | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Requisite deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRequisite | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | requisiteId | the Id of the Requisite |
Return | boolean | false if deletion of this Requisite is not
authorized, true otherwise | |
Errors | NULL_ARGUMENT | requisiteId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteRequisite | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | requisiteId | the Id of the Requisite to remove |
Errors | NOT_FOUND | requisiteId not found | |
NULL_ARGUMENT | requisiteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRequisiteAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Requisite aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRequisite | ||
Description |
Adds an | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | requisiteId not found | ||
NULL_ARGUMENT | requisiteId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addRequsiteOption | ||
Description |
Adds a | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | requisiteOptionId | the Id of a Requisite option | |
Errors | ALREADY_EXISTS | requisiteOptionId is already part of requisiteId
| |
NOT_FOUND | requisiteId or requisiteOptionId not found | ||
NULL_ARGUMENT | requisiteId or requisiteOptionId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRequsiteOption | ||
Description |
Removes a | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | requisiteOptionId | the Id of a Requisite option | |
Errors | NOT_FOUND | requisiteId or requisiteOptionId not found or
requisiteOptionId not part of requisiteId | |
NULL_ARGUMENT | requisiteId or requisiteOptionId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRequsiteOptions | ||
Description |
Removes all | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
Errors | NOT_FOUND | requisiteId not found | |
NULL_ARGUMENT | requisiteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCourseRequirements | ||
Description |
Tests if this user can create | ||
Return | boolean | false if CourseRequirement creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCourseRequirementWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | courseRequirementRecordTypes | array of course requirement record types |
Return | boolean | true if CourseRequirement creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | courseRequirementRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseRequirementFormForCreate | ||
Description |
Gets the course requirement form for creating new course requirements. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | courseId | an Id of a Course |
osid.type.Type[] | courseRequirementRecordTypes | array of course requirement record types | |
Return | osid.course.requisite.CourseRequirementForm | the course requirement form | |
Errors | NOT_FOUND | courseId is not found | |
NULL_ARGUMENT | courseId or courseRequirementRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createCourseRequirement | ||
Description |
Creates a new | ||
Parameters | osid.id.Id | courseId | an Id of a Course |
osid.course.requisite.CourseRequirementForm | courseRequirementForm | the form for this CourseRequirement | |
Return | osid.course.requisite.CourseRequirement | the new CourseRequirement | |
Errors | ALREADY_EXISTS | attempt at duplicating a property the underlying system is enforcing to be unique | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NOT_FOUND | courseId is not found | ||
NULL_ARGUMENT | courseId or courseRequirementForm is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | courseRequirementForm is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCourseRequirements | ||
Description |
Tests if this user can update | ||
Return | boolean | false if CourseRequirement modification is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCourseRequirement | ||
Description |
Tests if this user can update a specified | ||
Parameters | osid.id.Id | courseRequirementId | the Id of the CourseRequirement |
Return | boolean | false if course requirement modification is not authorized,
true otherwise | |
Errors | NULL_ARGUMENT | courseRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | getCourseRequirementFormForUpdate | ||
Description |
Gets the course requirement form for updating an existing course requirement. A new requisite form should be requested for each update transaction. | ||
Parameters | osid.id.Id | courseRequirementId | the Id of the CourseRequirement |
Return | osid.course.requisite.CourseRequirementForm | the course requirement form | |
Errors | NOT_FOUND | courseRequirementId is not found | |
NULL_ARGUMENT | courseRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCourseRequirement | ||
Description |
Updates an existing course requirement. | ||
Parameters | osid.id.Id | courseRequirementId | the Id of the CourseRequirement |
osid.course.requisite.CourseRequirementForm | courseRequirementForm | the form containing the elements to be updated | |
Errors | INVALID_ARGUMENT | the form contains an invalid value | |
NOT_FOUND | courseRequirementId is not found | ||
NULL_ARGUMENT | courseRequirementId or courseRequirementForm
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | courseRequirementForm is not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCourseRequirements | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if CourseRequirement deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCourseRequirement | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | courseRequirementId | the Id of the CourseRequirement |
Return | boolean | false if deletion of this CourseRequirement
is not authorized, true otherwise | |
Errors | NULL_ARGUMENT | courseRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteCourseRequirement | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | courseRequirementId | the Id of the CourseRequirement to remove |
Errors | NOT_FOUND | courseRequirementId not found | |
NULL_ARGUMENT | courseRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteCourseRequirements | ||
Description |
Deletes all | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCourseRequirementAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if CourseRequirement aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCourseRequirement | ||
Description |
Adds an | ||
Parameters | osid.id.Id | courseRequirementId | the Id of a CourseRequirement |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | courseRequirementId not found | ||
NULL_ARGUMENT | courseRequirementId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addCourseRequirement | ||
Description |
Adds a | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | courseRequirementId | the Id of a CourseRequirement | |
Errors | ALREADY_EXISTS | courseRequirementId is already part of requisiteId
| |
NOT_FOUND | requisiteId or courseRequirementId not found | ||
NULL_ARGUMENT | requisiteId or courseRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeCourseRequirement | ||
Description |
Removes a | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | courseRequirementId | the Id of a CourseRequirement | |
Errors | NOT_FOUND | requisiteId or courseRequirementId not found
or courseRequirementId not part of requisiteId | |
NULL_ARGUMENT | requisiteId or courseRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeCourseRequirements | ||
Description |
Removes all | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
Errors | NOT_FOUND | requisiteId not found | |
NULL_ARGUMENT | requisiteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addAltRequisiteToCourseRequirement | ||
Description |
Adds an alternative | ||
Parameters | osid.id.Id | courseRequirementId | the Id of a CourseRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | ALREADY_EXISTS | requisiteId is already part of courseRequirementId
| |
NOT_FOUND | courseRequirementId or requisiteId not found | ||
NULL_ARGUMENT | courseRequirementId or requisiteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisiteFromCourseRequirement | ||
Description |
Removes an alternative | ||
Parameters | osid.id.Id | courseRequirementId | the Id of a CourseRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | NOT_FOUND | courseRequirementId or requisiteId not found
or requisiteId not part of courseRequirementId | |
NULL_ARGUMENT | courseRequirementId or requisiteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisitesFromCourseRequirement | ||
Description |
Removes all | ||
Parameters | osid.id.Id | courseRequirementId | the Id of a CourseRequirement |
Errors | NOT_FOUND | courseRequirementId not found | |
NULL_ARGUMENT | courseRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProgramRequirements | ||
Description |
Tests if this user can create | ||
Return | boolean | false if ProgramRequirement creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProgramRequirementWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | programRequirementRecordTypes | array of program requirement record types |
Return | boolean | true if ProgramRequirement creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | programRequirementRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramRequirementFormForCreate | ||
Description |
Gets the program requirement form for creating new program requirements. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | programId | an Id of a program |
osid.type.Type[] | programRequirementRecordTypes | array of program requirement record types | |
Return | osid.course.requisite.ProgramRequirementForm | the program requirement form | |
Errors | NOT_FOUND | programId is not found | |
NULL_ARGUMENT | programRequirementRecordTypes is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createProgramRequirement | ||
Description |
Creates a new | ||
Parameters | osid.id.Id | programId | an Id of a program |
osid.course.requisite.ProgramRequirementForm | programRequirementForm | the form for this ProgramRequirement | |
Return | osid.course.requisite.ProgramRequirement | the new ProgramRequirement | |
Errors | ALREADY_EXISTS | attempt at duplicating a property the underlying system is enforcing to be unique | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NOT_FOUND | programId is not found | ||
NULL_ARGUMENT | programId or programRequirementForm is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | programRequirementForm is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateProgramRequirements | ||
Description |
Tests if this user can update | ||
Return | boolean | false if ProgramRequirement modification is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateProgramRequirement | ||
Description |
Tests if this user can update a specified | ||
Parameters | osid.id.Id | programRequirementId | the Id of the ProgramRequirement |
Return | boolean | false if program requirement modification is not authorized,
true otherwise | |
Errors | NULL_ARGUMENT | programRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | getProgramRequirementFormForUpdate | ||
Description |
Gets the program requirement form for updating an existing program requirement. A new requisite form should be requested for each update transaction. | ||
Parameters | osid.id.Id | programRequirementId | the Id of the ProgramRequirement |
Return | osid.course.requisite.ProgramRequirementForm | the program requirement form | |
Errors | NOT_FOUND | programRequirementId is not found | |
NULL_ARGUMENT | programRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProgramRequirement | ||
Description |
Updates an existing program requirement. | ||
Parameters | osid.id.Id | programRequirementId | the Id of the ProgramRequirement |
osid.course.requisite.ProgramRequirementForm | programRequirementForm | the form containing the elements to be updated | |
Errors | INVALID_ARGUMENT | the form contains an invalid value | |
NOT_FOUND | programRequirementId is not found | ||
NULL_ARGUMENT | programRequirementId or programRequirementForm
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | programRequirementForm is not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteProgramRequirements | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if ProgramRequirement deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteProgramRequirement | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | programRequirementId | the Id of the ProgramRequirement |
Return | boolean | false if deletion of this ProgramRequirement
is not authorized, true otherwise | |
Errors | NULL_ARGUMENT | programRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteProgramRequirement | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | programRequirementId | the Id of the ProgramRequirement to remove |
Errors | NOT_FOUND | programRequirementId not found | |
NULL_ARGUMENT | programRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteProgramRequirements | ||
Description |
Deletes all | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageProgramRequirementAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if ProgramRequirement aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasProgramRequirement | ||
Description |
Adds an | ||
Parameters | osid.id.Id | programRequirementId | the Id of a ProgramRequirement |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | programRequirementId not found | ||
NULL_ARGUMENT | programRequirementId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addProgramRequirement | ||
Description |
Adds a | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | programRequirementId | the Id of a ProgramRequirement | |
Errors | ALREADY_EXISTS | programRequirementId is already part of requisiteId
| |
NOT_FOUND | requisiteId or programRequirementId not found | ||
NULL_ARGUMENT | requisiteId or programRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeProgramRequirement | ||
Description |
Removes a | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | programRequirementId | the Id of a ProgramRequirement | |
Errors | NOT_FOUND | requisiteId or programRequirementId not found
or programRequirementId not part of requisiteId | |
NULL_ARGUMENT | requisiteId or programRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeProgramRequirements | ||
Description |
Removes all | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
Errors | NOT_FOUND | requisiteId not found | |
NULL_ARGUMENT | requisiteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addAltRequisiteToProgramRequirement | ||
Description |
Adds an alternative | ||
Parameters | osid.id.Id | programRequirementId | the Id of a ProgramRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | ALREADY_EXISTS | requisiteId is already part of programRequirementId
| |
NOT_FOUND | programRequirementId or requisiteId not found | ||
NULL_ARGUMENT | programRequirementId or requisiteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisiteFromProgramRequirement | ||
Description |
Removes an alternative | ||
Parameters | osid.id.Id | programRequirementId | the Id of a ProgramRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | NOT_FOUND | programRequirementId or requisiteId not found
or requisiteId not part of programRequirementId | |
NULL_ARGUMENT | programRequirementId or requisiteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisitesFromProgramRequirement | ||
Description |
Removes all | ||
Parameters | osid.id.Id | programRequirementId | the Id of a ProgramRequirement |
Errors | NOT_FOUND | programRequirementId not found | |
NULL_ARGUMENT | programRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCredentialRequirements | ||
Description |
Tests if this user can create | ||
Return | boolean | false if CredentialRequirement creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateCredentiaRequirementWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | credentialRequirementRecordTypes | array of credential requirement record types |
Return | boolean | true if CredentialRequirement creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | credentialRequirementRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getCredentialRequirementFormForCreate | ||
Description |
Gets the credential requirement form for creating new credential requirements. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | credentialId | a credential Id |
osid.type.Type[] | credentialRequirementRecordTypes | array of credential requirement record types | |
Return | osid.course.requisite.CredentialRequirementForm | the credential requirement form | |
Errors | NOT_FOUND | credentialId is not found | |
NULL_ARGUMENT | credentialId or credentialRequirementRecordTypes
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createCredentialRequirement | ||
Description |
Creates a new | ||
Parameters | osid.id.Id | credentialId | a credential Id |
osid.course.requisite.CredentialRequirementForm | credentialRequirementForm | the form for this CredentialRequirement | |
Return | osid.course.requisite.CredentialRequirement | the new CredentialRequirement | |
Errors | ALREADY_EXISTS | attempt at duplicating a property the underlying system is enforcing to be unique | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NOT_FOUND | credentialId is not found | ||
NULL_ARGUMENT | credentialId or credentialRequirementForm is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | credentialRequirementForm is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCredentialRequirements | ||
Description |
Tests if this user can update | ||
Return | boolean | false if CredentialRequirement modification
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateCredentialRequirement | ||
Description |
Tests if this user can update a specified | ||
Parameters | osid.id.Id | credentialRequirementId | the Id of the CredentialRequirement |
Return | boolean | false if credential requirement modification is not
authorized, true otherwise | |
Errors | NULL_ARGUMENT | credentialRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | getCredentialRequirementFormForUpdate | ||
Description |
Gets the credential requirement form for updating an existing credential requirement. A new requisite form should be requested for each update transaction. | ||
Parameters | osid.id.Id | credentialRequirementId | the Id of the CredentialRequirement |
Return | osid.course.requisite.CredentialRequirementForm | the credential requirement form | |
Errors | NOT_FOUND | credentialRequirementId is not found | |
NULL_ARGUMENT | credentialRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCredentialRequirement | ||
Description |
Updates an existing credential requirement. | ||
Parameters | osid.id.Id | credentialRequirementId | the Id of the CredentialRequirement |
osid.course.requisite.CredentialRequirementForm | credentialRequirementForm | the form containing the elements to be updated | |
Errors | INVALID_ARGUMENT | the form contains an invalid value | |
NOT_FOUND | credentialRequirementId is not found | ||
NULL_ARGUMENT | credentialRequirementId or credentialRequirementForm
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | credentialRequirementForm is not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCredentialRequirements | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if CredentialRequirement deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteCredentialRequirement | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | credentialRequirementId | the Id of the CredentialRequirement |
Return | boolean | false if deletion of this CredentialRequirement
is not authorized, true otherwise | |
Errors | NULL_ARGUMENT | credentialRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteCredentialRequirement | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | credentialRequirementId | the Id of the CredentialRequirement to remove |
Errors | NOT_FOUND | credentialRequirementId not found | |
NULL_ARGUMENT | credentialRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteCredentialRequirements | ||
Description |
Deletes all | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageCredentialRequirementAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if CredentialRequirement aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasCredentialRequirement | ||
Description |
Adds an | ||
Parameters | osid.id.Id | credentialRequirementId | the Id of a CredentialRequirement |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | credentialRequirementId not found | ||
NULL_ARGUMENT | credentialRequirementId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addCredentialRequirement | ||
Description |
Adds a | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | credentialRequirementId | the Id of a CredentialRequirement | |
Errors | ALREADY_EXISTS | credentialRequirementId is already part of
requisiteId | |
NOT_FOUND | requisiteId or credentialRequirementId not
found | ||
NULL_ARGUMENT | requisiteId or credentialRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeCredentialRequirement | ||
Description |
Removes a | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | credentialRequirementId | the Id of a CredentialRequirement | |
Errors | NOT_FOUND | requisiteId or credentialRequirementId not
found or credentialRequirementId not part of requisiteId
| |
NULL_ARGUMENT | requisiteId or credentialRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeCredentialRequirements | ||
Description |
Removes all | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
Errors | NOT_FOUND | requisiteId not found | |
NULL_ARGUMENT | requisiteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addAltRequisiteToCredentialRequirement | ||
Description |
Adds an alternative | ||
Parameters | osid.id.Id | credentialRequirementId | the Id of a CredentialRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | ALREADY_EXISTS | requisiteId is already part of
credentialRequirementId | |
NOT_FOUND | credentialRequirementId or requisiteId not
found | ||
NULL_ARGUMENT | credentialRequirementId or requisiteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisiteFromCredentialRequirement | ||
Description |
Removes an alternative | ||
Parameters | osid.id.Id | credentialRequirementId | the Id of a CredentialRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | NOT_FOUND | credentialRequirementId or requisiteId not
found or requisiteId not part of credentialRequirementId
| |
NULL_ARGUMENT | credentialRequirementId or requisiteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisitesFromCredentialRequirement | ||
Description |
Removes all | ||
Parameters | osid.id.Id | credentialRequirementId | the Id of a CredentialRequirement |
Errors | NOT_FOUND | credentialRequirementId not found | |
NULL_ARGUMENT | credentialRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateLearningObjectiveRequirements | ||
Description |
Tests if this user can create | ||
Return | boolean | false if LearningObjectiveRequirement
creation is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateLearningObjectiveRequirementWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | learningObjectiveRequirementRecordTypes | array of learning objective requirement record types |
Return | boolean | true if LearningObjectiveRequirement creation
using the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | learningObjectiveRequirementRecordTypes is null
| |
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveRequirementFormForCreate | ||
Description |
Gets the learning objective requirement form for creating new learning objective requirements. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | objectiveId | a learning objective Id |
osid.type.Type[] | learningObjectiveRequirementForm | array of learning objective requirement record types | |
Return | osid.course.requisite.LearningObjectiveRequirementForm | the learning objective requirement form | |
Errors | NOT_FOUND | objectiveId is not found | |
NULL_ARGUMENT | objectiveId or
learningObjectiveRequirementRecordTypes is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createLearningObjectiveRequirement | ||
Description |
Creates a new | ||
Parameters | osid.id.Id | objectiveId | a learning objective Id |
osid.course.requisite.LearningObjectiveRequirementForm | learningObjectiveRequirementForm | the form for this LearningObjectiveRequirement | |
Return | osid.course.requisite.LearningObjectiveRequirement | the new LearningObjectiveRequirement | |
Errors | ALREADY_EXISTS | attempt at duplicating a property the underlying system is enforcing to be unique | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NOT_FOUND | objectiveId is not found | ||
NULL_ARGUMENT | objectiveId or learningObjectiveRequirementForm
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | learningObjectiveRequirementForm is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateLearningObjectiveRequirements | ||
Description |
Tests if this user can update | ||
Return | boolean | false if LearningObjectiveRequirement
modification is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateLearningObjectiveRequirement | ||
Description |
Tests if this user can update a specified | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | the Id of the LearningObjectiveRequirement |
Return | boolean | false if learning objective requirement modification is not
authorized, true otherwise | |
Errors | NULL_ARGUMENT | learningObjectiveRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | getLearningObjectiveRequirementFormForUpdate | ||
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. | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | the Id of the LearningObjectiveRequirement |
Return | osid.course.requisite.LearningObjectiveRequirementForm | the learning objective requirement form | |
Errors | NOT_FOUND | learningObjectiveRequirementId is not found | |
NULL_ARGUMENT | learningObjectiveRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateLearningObjectiveRequirement | ||
Description |
Updates an existing learning objective requirement. | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | the Id of the LearningObjectiveRequirement |
osid.course.requisite.LearningObjectiveRequirementForm | learningObjectiveRequirementForm | the form containing the elements to be updated | |
Errors | INVALID_ARGUMENT | the form contains an invalid value | |
NOT_FOUND | learningObjectiveRequirementId is not found | ||
NULL_ARGUMENT | learningObjectiveRequirementId or
learningObjectiveRequirementForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | learningObjectiveRequirementForm is not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteLearningObjectiveRequirements | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if LearningObjectiveRequirement
deletion is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteLearningObjectiveRequirement | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | the Id of the LearningObjectiveRequirement |
Return | boolean | false if deletion of this
LearningObjectiveRequirement is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | learningObjectiveRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteLearningObjectiveRequirement | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | the Id of the LearningObjectiveRequirement to
remove |
Errors | NOT_FOUND | learningObjectiveRequirementId not found | |
NULL_ARGUMENT | learningObjectiveRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteLearningObjectiveRequirements | ||
Description |
Deletes all | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageLearningObjectiveRequirementAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if LearningObjectiveRequirement
aliasing is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasLearningObjectiveRequirement | ||
Description |
Adds an | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | the Id of a LearningObjectiveRequirement |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | learningObjectiveRequirementId not found | ||
NULL_ARGUMENT | learningObjectiveRequirementId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addLearningObjectiveRequirement | ||
Description |
Adds a | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | learningObjectiveRequirementId | the Id of a LearningObjectiveRequirement | |
Errors | ALREADY_EXISTS | learningObjectiveRequirementId is already part of
requisiteId | |
NOT_FOUND | requisiteId or learningObjectiveRequirementId
not found | ||
NULL_ARGUMENT | requisiteId or learningObjectiveRequirementId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeLearningObjectiveRequirement | ||
Description |
Removes a | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | learningObjectiveRequirementId | the Id of a LearningObjectiveRequirement | |
Errors | NOT_FOUND | requisiteId or learningObjectiveRequirementId
not found or learningObjectiveRequirementId not part of
requisiteId | |
NULL_ARGUMENT | requisiteId or credentialRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeLearningObjectiveRequirements | ||
Description |
Removes all | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
Errors | NOT_FOUND | requisiteId not found | |
NULL_ARGUMENT | requisiteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addAltRequisiteToLearningObjectiveRequirement | ||
Description |
Adds an alternative | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | the Id of a LearningObjectiveRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | ALREADY_EXISTS | requisiteId is already part of
learningObjectiveRequirementId | |
NOT_FOUND | learningObjectiveRequirementId or requisiteId
not found | ||
NULL_ARGUMENT | learningObjectiveRequirementId or requisiteId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisiteFromLearningObjectiveRequirement | ||
Description |
Removes an alternative | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | the Id of a LearningObjectiveRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | NOT_FOUND | learningObjectiveRequirementId or requisiteId
not found or requisiteId not part of
learningObjectiveRequirementId | |
NULL_ARGUMENT | learningObjectiveRequirementId or requisiteId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisitesFromLearningObjectiveRequirement | ||
Description |
Removes all | ||
Parameters | osid.id.Id | learningObjectiveRequirementId | the Id of a LearningObjectiveRequirement |
Errors | NOT_FOUND | learningObjectiveRequirementId not found | |
NULL_ARGUMENT | learningObjectiveRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAssessmentRequirements | ||
Description |
Tests if this user can create | ||
Return | boolean | false if AssessmentRequirement creation is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAssessmentRequirementWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | assessmentRequirementRecordTypes | array of assessment requirement record types |
Return | boolean | true if AssessmentRequirement creation using
the specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | assessmentRequirementRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentRequirementFormForCreate | ||
Description |
Gets the assessment requirement form for creating new credential requirements. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | assessmentId | a assessment Id |
osid.type.Type[] | assessmentRequirementRecordTypes | array of assessment requirement record types | |
Return | osid.course.requisite.AssessmentRequirementForm | the assessment requirement form | |
Errors | NOT_FOUND | assessmentId is not found | |
NULL_ARGUMENT | assessmentId or assessmentRequirementRecordTypes
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createAssessmentRequirement | ||
Description |
Creates a new | ||
Parameters | osid.id.Id | assessmentId | an assessment Id |
osid.course.requisite.AssessmentRequirementForm | assessmentRequirementForm | the form for this AssessmentRequirement | |
Return | osid.course.requisite.AssessmentRequirement | the new AssessmentRequirement | |
Errors | ALREADY_EXISTS | attempt at duplicating a property the underlying system is enforcing to be unique | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NOT_FOUND | assessmentId is not found | ||
NULL_ARGUMENT | assessmentid or assessmentRequirementForm is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | assessmentRequirementForm is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAssessmentRequirements | ||
Description |
Tests if this user can update | ||
Return | boolean | false if AssessmentRequirement modification
is not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAssessmentRequirement | ||
Description |
Tests if this user can update a specified | ||
Parameters | osid.id.Id | assessmentRequirementId | the Id of the AssessmentRequirement |
Return | boolean | false if assessment requirement modification is not
authorized, true otherwise | |
Errors | NULL_ARGUMENT | assessmentRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | getAssessmentRequirementFormForUpdate | ||
Description |
Gets the assessment requirement form for updating an existing credential requirement. A new requisite form should be requested for each update transaction. | ||
Parameters | osid.id.Id | assessmentRequirementId | the Id of the AssessmentRequirement |
Return | osid.course.requisite.AssessmentRequirementForm | the assessment requirement form | |
Errors | NOT_FOUND | assessmentRequirementId is not found | |
NULL_ARGUMENT | assessmentRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAssessmentRequirement | ||
Description |
Updates an existing assessment requirement. | ||
Parameters | osid.id.Id | assessmentRequirementId | the Id of the AssessmentRequirement |
osid.course.requisite.AssessmentRequirementForm | assessmentRequirementForm | the form containing the elements to be updated | |
Errors | INVALID_ARGUMENT | the form contains an invalid value | |
NOT_FOUND | assessmentRequirementId is not found | ||
NULL_ARGUMENT | assessmentRequirementId or assessmentRequirementForm
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | assessmentRequirementForm is not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAssessmentRequirements | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if AssessmentRequirement deletion is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAssessmentRequirement | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | assessmentRequirementId | the Id of the AssessmentRequirement |
Return | boolean | false if deletion of this AssessmentRequirement
is not authorized, true otherwise | |
Errors | NULL_ARGUMENT | assessmentRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteAssessmentRequirement | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | assessmentRequirementId | the Id of the AssessmentRequirement to remove |
Errors | NOT_FOUND | assessmentRequirementId not found | |
NULL_ARGUMENT | assessmentRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAssessmentRequirements | ||
Description |
Deletes all | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAssessmentRequirementAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if AssessmentRequirement aliasing is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAssessmentRequirement | ||
Description |
Adds an | ||
Parameters | osid.id.Id | assessmentRequirementId | the Id of an AssessmentRequirement |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | assessmentRequirementId not found | ||
NULL_ARGUMENT | assessmentRequirementId or aliasId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addAssessmentRequirement | ||
Description |
Adds an | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | assessmentRequirementId | the Id of an AssessmentRequirement | |
Errors | ALREADY_EXISTS | assessmentRequirementId is already part of
requisiteId | |
NOT_FOUND | requisiteId or assessmentRequirementId not
found | ||
NULL_ARGUMENT | requisiteId or assessmentRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAssessmentRequirement | ||
Description |
Removes anAssessment | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | assessmentRequirementId | the Id of an AssessmentRequirement | |
Errors | NOT_FOUND | requisiteId or assessmentRequirementId not
found or assessmentRequirementId not part of requisiteId
| |
NULL_ARGUMENT | requisiteId or assessmentRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAssessmentRequirements | ||
Description |
Removes all | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
Errors | NOT_FOUND | requisiteId not found | |
NULL_ARGUMENT | requisiteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addAltRequisiteToAssessmentRequirement | ||
Description |
Adds an alternative | ||
Parameters | osid.id.Id | assessmentRequirementId | the Id of an AssessmentRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | ALREADY_EXISTS | requisiteId is already part of
assessmentRequirementId | |
NOT_FOUND | assessmentRequirementId or requisiteId not
found | ||
NULL_ARGUMENT | assessmentRequirementId or requisiteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisiteFromAssessmentRequirement | ||
Description |
Removes an alternative | ||
Parameters | osid.id.Id | assessmentRequirementId | the Id of an AssessmentRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | NOT_FOUND | assessmentRequirementId or requisiteId not
found or requisiteId not part of assessmentRequirementId
| |
NULL_ARGUMENT | assessmentRequirementId or requisiteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisitesFromAssessmentRequirement | ||
Description |
Removes all | ||
Parameters | osid.id.Id | assessmentRequirementId | the Id of an AssessmentRequirement |
Errors | NOT_FOUND | assessmentRequirementId not found | |
NULL_ARGUMENT | assessmentRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAwardRequirements | ||
Description |
Tests if this user can create | ||
Return | boolean | false if AwardRequirement creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateAwardRequirementWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | awardRequirementRecordTypes | array of award requirement record types |
Return | boolean | true if AwardRequirement creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | awardRequirementRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAwardRequirementFormForCreate | ||
Description |
Gets the award requirement form for creating new credential requirements. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | awardId | a award Id |
osid.type.Type[] | awardRequirementRecordTypes | array of award requirement record types | |
Return | osid.course.requisite.AwardRequirementForm | the award requirement form | |
Errors | NOT_FOUND | awardId is not found | |
NULL_ARGUMENT | awardId or awardRequirementRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createAwardRequirement | ||
Description |
Creates a new | ||
Parameters | osid.id.Id | awardId | an award Id |
osid.course.requisite.AwardRequirementForm | awardRequirementForm | the form for this AwardRequirement | |
Return | osid.course.requisite.AwardRequirement | the new AwardRequirement | |
Errors | ALREADY_EXISTS | attempt at duplicating a property the underlying system is enforcing to be unique | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NOT_FOUND | awardId is not found | ||
NULL_ARGUMENT | awardid or awardRequirementForm is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | awardRequirementForm is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAwardRequirements | ||
Description |
Tests if this user can update | ||
Return | boolean | false if AwardRequirement modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateAwardRequirement | ||
Description |
Tests if this user can update a specified | ||
Parameters | osid.id.Id | awardRequirementId | the Id of the AwardRequirement |
Return | boolean | false if award requirement modification is not authorized,
true otherwise | |
Errors | NULL_ARGUMENT | awardRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | getAwardRequirementFormForUpdate | ||
Description |
Gets the award requirement form for updating an existing credential requirement. A new requisite form should be requested for each update transaction. | ||
Parameters | osid.id.Id | awardRequirementId | the Id of the AwardRequirement |
Return | osid.course.requisite.AwardRequirementForm | the award requirement form | |
Errors | NOT_FOUND | awardRequirementId is not found | |
NULL_ARGUMENT | awardRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAwardRequirement | ||
Description |
Updates an existing award requirement. | ||
Parameters | osid.id.Id | awardRequirementId | the Id of the AwardRequirement |
osid.course.requisite.AwardRequirementForm | awardRequirementForm | the form containing the elements to be updated | |
Errors | INVALID_ARGUMENT | the form contains an invalid value | |
NOT_FOUND | awardRequirementId is not found | ||
NULL_ARGUMENT | awardRequirementId or awardRequirementForm is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | awardRequirementForm is not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAwardRequirements | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if AwardRequirement deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteAwardRequirement | ||
Description |
Tests if this user can delete a specified | ||
Parameters | osid.id.Id | awardRequirementId | the Id of the AwardRequirement |
Return | boolean | false if deletion of this AwardRequirement is
not authorized, true otherwise | |
Errors | NULL_ARGUMENT | awardRequirementId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | deleteAwardRequirement | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | awardRequirementId | the Id of the AwardRequirement to remove |
Errors | NOT_FOUND | awardRequirementId not found | |
NULL_ARGUMENT | awardRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAwardRequirements | ||
Description |
Deletes all | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageAwardRequirementAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if AwardRequirement aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAwardRequirement | ||
Description |
Adds an | ||
Parameters | osid.id.Id | awardRequirementId | the Id of an AwardRequirement |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | awardRequirementId not found | ||
NULL_ARGUMENT | awardRequirementId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addAwardRequirement | ||
Description |
Adds an | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | awardRequirementId | the Id of an AwardRequirement | |
Errors | ALREADY_EXISTS | awardRequirementId is already part of requisiteId
| |
NOT_FOUND | requisiteId or awardRequirementId not found | ||
NULL_ARGUMENT | requisiteId or awardRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAwardRequirement | ||
Description |
Removes anAward | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
osid.id.Id | awardRequirementId | the Id of an AwardRequirement | |
Errors | NOT_FOUND | requisiteId or awardRequirementId not found
or awardRequirementId not part of requisiteId | |
NULL_ARGUMENT | requisiteId or awardRequirementId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAwardRequirements | ||
Description |
Removes all | ||
Parameters | osid.id.Id | requisiteId | the Id of a Requisite |
Errors | NOT_FOUND | requisiteId not found | |
NULL_ARGUMENT | requisiteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addAltRequisiteToAwardRequirement | ||
Description |
Adds an alternative | ||
Parameters | osid.id.Id | awardRequirementId | the Id of an AwardRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | ALREADY_EXISTS | requisiteId is already part of awardRequirementId
| |
NOT_FOUND | awardRequirementId or requisiteId not found | ||
NULL_ARGUMENT | awardRequirementId or requisiteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisiteFromAwardRequirement | ||
Description |
Removes an alternative | ||
Parameters | osid.id.Id | awardRequirementId | the Id of an AwardRequirement |
osid.id.Id | requisiteId | the Id of a Requisite | |
Errors | NOT_FOUND | awardRequirementId or requisiteId not found
or requisiteId not part of awardRequirementId | |
NULL_ARGUMENT | awardRequirementId or requisiteId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeAltRequisitesFromAwardRequirement | ||
Description |
Removes all | ||
Parameters | osid.id.Id | awardRequirementId | the Id of an AwardRequirement |
Errors | NOT_FOUND | awardRequirementId not found | |
NULL_ARGUMENT | awardRequirementId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |