RequisiteAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession
```
public interface RequisiteAdminSession
extends OsidSession
```
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.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAltRequisiteToAssessmentRequirement(Id assessmentRequirementId, Id requisiteId)` Adds an alternative `Requisite` to an `AssessmentRequirement.`
`void`	`addAltRequisiteToAwardRequirement(Id awardRequirementId, Id requisiteId)` Adds an alternative `Requisite` to an `AwardRequirement.`
`void`	`addAltRequisiteToCourseRequirement(Id courseRequirementId, Id requisiteId)` Adds an alternative `Requisite` to a `CourseRequirement.`
`void`	`addAltRequisiteToCredentialRequirement(Id credentialRequirementId, Id requisiteId)` Adds an alternative `Requisite` to a `CredentialRequirement.`
`void`	`addAltRequisiteToLearningObjectiveRequirement(Id learningObjectiveRequirementId, Id requisiteId)` Adds an alternative `Requisite` to a `LearningObjectiveRequirement.`
`void`	`addAltRequisiteToProgramRequirement(Id programRequirementId, Id requisiteId)` Adds an alternative `Requisite` to a `ProgramRequirement.`
`void`	`addAssessmentRequirement(Id requisiteId, Id assessmentRequirementId)` Adds an `AssessmentRequirement` to a `Requisite.`
`void`	`addAwardRequirement(Id requisiteId, Id awardRequirementId)` Adds an `AwardRequirement` to a `Requisite.`
`void`	`addCourseRequirement(Id requisiteId, Id courseRequirementId)` Adds a `CourseRequirement` to a `Requisite.`
`void`	`addCredentialRequirement(Id requisiteId, Id credentialRequirementId)` Adds a `CredentialRequirement` to a `Requisite.`
`void`	`addLearningObjectiveRequirement(Id requisiteId, Id learningObjectiveRequirementId)` Adds a `LearningObjectiveRequirement` to a `Requisite.`
`void`	`addProgramRequirement(Id requisiteId, Id programRequirementId)` Adds a `ProgramRequirement` to a `Requisite.`
`void`	`addRequsiteOption(Id requisiteId, Id requisiteOptionId)` Adds a `Requisite` as an option to a `Requisite.`
`void`	`aliasAssessmentRequirement(Id assessmentRequirementId, Id aliasId)` Adds an `Id` to an `AssessmentRequirement` for the purpose of creating compatibility.
`void`	`aliasAwardRequirement(Id awardRequirementId, Id aliasId)` Adds an `Id` to an `AwardRequirement` for the purpose of creating compatibility.
`void`	`aliasCourseRequirement(Id courseRequirementId, Id aliasId)` Adds an `Id` to a `CourseRequirement` for the purpose of creating compatibility.
`void`	`aliasCredentialRequirement(Id credentialRequirementId, Id aliasId)` Adds an `Id` to a `CredentialRequirement` for the purpose of creating compatibility.
`void`	`aliasLearningObjectiveRequirement(Id learningObjectiveRequirementId, Id aliasId)` Adds an `Id` to a `LearningObjectiveRequirement` for the purpose of creating compatibility.
`void`	`aliasProgramRequirement(Id programRequirementId, Id aliasId)` Adds an `Id` to a `ProgramRequirement` for the purpose of creating compatibility.
`void`	`aliasRequisite(Id requisiteId, Id aliasId)` Adds an `Id` to a `Requisite` for the purpose of creating compatibility.
`boolean`	`canCreateAssessmentRequirements()` Tests if this user can create `AssessmentRequirements.`
`boolean`	`canCreateAssessmentRequirementWithRecordTypes(Type[] assessmentRequirementRecordTypes)` Tests if this user can create a single `AssessmentRequirement` using the desired record types.
`boolean`	`canCreateAwardRequirements()` Tests if this user can create `AwardRequirements.`
`boolean`	`canCreateAwardRequirementWithRecordTypes(Type[] awardRequirementRecordTypes)` Tests if this user can create a single `AwardRequirement` using the desired record types.
`boolean`	`canCreateCourseRequirements()` Tests if this user can create `CourseRequirements.`
`boolean`	`canCreateCourseRequirementWithRecordTypes(Type[] courseRequirementRecordTypes)` Tests if this user can create a single `CourseRequirement` using the desired record types.
`boolean`	`canCreateCredentialRequirements()` Tests if this user can create `CredentialRequirements.`
`boolean`	`canCreateCredentiaRequirementWithRecordTypes(Type[] credentialRequirementRecordTypes)` Tests if this user can create a single `CredentialRequirement` using the desired record types.
`boolean`	`canCreateLearningObjectiveRequirements()` Tests if this user can create `LearningObjectiveRequirements.`
`boolean`	`canCreateLearningObjectiveRequirementWithRecordTypes(Type[] learningObjectiveRequirementRecordTypes)` Tests if this user can create a single `LearningObjectiveRequirement` using the desired record types.
`boolean`	`canCreateProgramRequirements()` Tests if this user can create `ProgramRequirements.`
`boolean`	`canCreateProgramRequirementWithRecordTypes(Type[] programRequirementRecordTypes)` Tests if this user can create a single `ProgramRequirement` using the desired record types.
`boolean`	`canCreateRequisites()` Tests if this user can create `Requisites.`
`boolean`	`canCreateRequisiteWithRecordTypes(Type[] requisiteRecordTypes)` Tests if this user can create a single `Porgram` using the desired record types.
`boolean`	`canDeleteAssessmentRequirement(Id assessmentRequirementId)` Tests if this user can delete a specified `AssessmentRequirement.`
`boolean`	`canDeleteAssessmentRequirements()` Tests if this user can delete `AssessmentRequirements.`
`boolean`	`canDeleteAwardRequirement(Id awardRequirementId)` Tests if this user can delete a specified `AwardRequirement.`
`boolean`	`canDeleteAwardRequirements()` Tests if this user can delete `AwardRequirements.`
`boolean`	`canDeleteCourseRequirement(Id courseRequirementId)` Tests if this user can delete a specified `CourseRequirement.`
`boolean`	`canDeleteCourseRequirements()` Tests if this user can delete `CourseRequirements.`
`boolean`	`canDeleteCredentialRequirement(Id credentialRequirementId)` Tests if this user can delete a specified `CredentialRequirement.`
`boolean`	`canDeleteCredentialRequirements()` Tests if this user can delete `CredentialRequirements.`
`boolean`	`canDeleteLearningObjectiveRequirement(Id learningObjectiveRequirementId)` Tests if this user can delete a specified `LearningObjectiveRequirement.`
`boolean`	`canDeleteLearningObjectiveRequirements()` Tests if this user can delete `LearningObjectiveRequirements.`
`boolean`	`canDeleteProgramRequirement(Id programRequirementId)` Tests if this user can delete a specified `ProgramRequirement.`
`boolean`	`canDeleteProgramRequirements()` Tests if this user can delete `ProgramRequirements.`
`boolean`	`canDeleteRequisite(Id requisiteId)` Tests if this user can delete a specified `Requisite.`
`boolean`	`canDeleteRequisites()` Tests if this user can delete `Requisites.`
`boolean`	`canManageAssessmentRequirementAliases()` Tests if this user can manage `Id` aliases for `AssessmentRequirements.`
`boolean`	`canManageAwardRequirementAliases()` Tests if this user can manage `Id` aliases for `AwardRequirements.`
`boolean`	`canManageCourseRequirementAliases()` Tests if this user can manage `Id` aliases for `CourseRequirements.`
`boolean`	`canManageCredentialRequirementAliases()` Tests if this user can manage `Id` aliases for `CredentialRequirements.`
`boolean`	`canManageLearningObjectiveRequirementAliases()` Tests if this user can manage `Id` aliases for `LearningObjectiveRequirements.`
`boolean`	`canManageProgramRequirementAliases()` Tests if this user can manage `Id` aliases for `ProgramRequirements.`
`boolean`	`canManageRequisiteAliases()` Tests if this user can manage `Id` aliases for `Requisites.`
`boolean`	`canUpdateAssessmentRequirement(Id assessmentRequirementId)` Tests if this user can update a specified `AssessmentRequirement.`
`boolean`	`canUpdateAssessmentRequirements()` Tests if this user can update `AssessmentRequirements.`
`boolean`	`canUpdateAwardRequirement(Id awardRequirementId)` Tests if this user can update a specified `AwardRequirement.`
`boolean`	`canUpdateAwardRequirements()` Tests if this user can update `AwardRequirements.`
`boolean`	`canUpdateCourseRequirement(Id courseRequirementId)` Tests if this user can update a specified `CourseRequirement.`
`boolean`	`canUpdateCourseRequirements()` Tests if this user can update `CourseRequirements.`
`boolean`	`canUpdateCredentialRequirement(Id credentialRequirementId)` Tests if this user can update a specified `CredentialRequirement.`
`boolean`	`canUpdateCredentialRequirements()` Tests if this user can update `CredentialRequirements.`
`boolean`	`canUpdateLearningObjectiveRequirement(Id learningObjectiveRequirementId)` Tests if this user can update a specified `LearningObjectiveRequirement.`
`boolean`	`canUpdateLearningObjectiveRequirements()` Tests if this user can update `LearningObjectiveRequirements.`
`boolean`	`canUpdateProgramRequirement(Id programRequirementId)` Tests if this user can update a specified `ProgramRequirement.`
`boolean`	`canUpdateProgramRequirements()` Tests if this user can update `ProgramRequirements.`
`boolean`	`canUpdateRequisites()` Tests if this user can update `Requisites.`
`AssessmentRequirement`	`createAssessmentRequirement(Id assessmentId, AssessmentRequirementForm assessmentRequirementForm)` Creates a new `AssessmentRequirement.`
`AwardRequirement`	`createAwardRequirement(Id awardId, AwardRequirementForm awardRequirementForm)` Creates a new `AwardRequirement.`
`CourseRequirement`	`createCourseRequirement(Id courseId, CourseRequirementForm courseRequirementForm)` Creates a new `CourseRequirement.`
`CredentialRequirement`	`createCredentialRequirement(Id credentialId, CredentialRequirementForm credentialRequirementForm)` Creates a new `CredentialRequirement.`
`LearningObjectiveRequirement`	`createLearningObjectiveRequirement(Id objectiveId, LearningObjectiveRequirementForm learningObjectiveRequirementForm)` Creates a new `LearningObjectiveRequirement.`
`ProgramRequirement`	`createProgramRequirement(Id programId, ProgramRequirementForm programRequirementForm)` Creates a new `ProgramRequirement.`
`Requisite`	`createRequisite(RequisiteForm requisiteForm)` Creates a new `Requisite.`
`void`	`deleteAssessmentRequirement(Id assessmentRequirementId)` Deletes an `AssessmentRequirement.`
`void`	`deleteAssessmentRequirements()` Deletes all `AssessmentRequirements` in this `CourseCatalog.`
`void`	`deleteAwardRequirement(Id awardRequirementId)` Deletes an `AwardRequirement.`
`void`	`deleteAwardRequirements()` Deletes all `AwardRequirements` in this `CourseCatalog.`
`void`	`deleteCourseRequirement(Id courseRequirementId)` Deletes a `CourseRequirement.`
`void`	`deleteCourseRequirements()` Deletes all `CourseRequirements` in this `CourseCatalog.`
`void`	`deleteCredentialRequirement(Id credentialRequirementId)` Deletes a `CredentialRequirement.`
`void`	`deleteCredentialRequirements()` Deletes all `CredentialRequirements` in this `CourseCatalog.`
`void`	`deleteLearningObjectiveRequirement(Id learningObjectiveRequirementId)` Deletes a `LearningObjectiveRequirement.`
`void`	`deleteLearningObjectiveRequirements()` Deletes all `LearningObjectiveRequirements` in this `CourseCatalog.`
`void`	`deleteProgramRequirement(Id programRequirementId)` Deletes a `ProgramRequirement.`
`void`	`deleteProgramRequirements()` Deletes all `ProgramRequirements` in this `CourseCatalog.`
`void`	`deleteRequisite(Id requisiteId)` Deletes a `Requisite.`
`AssessmentRequirementForm`	`getAssessmentRequirementFormForCreate(Id assessmentId, Type[] assessmentRequirementRecordTypes)` Gets the assessment requirement form for creating new credential requirements.
`AssessmentRequirementForm`	`getAssessmentRequirementFormForUpdate(Id assessmentRequirementId)` Gets the assessment requirement form for updating an existing credential requirement.
`AwardRequirementForm`	`getAwardRequirementFormForCreate(Id awardId, Type[] awardRequirementRecordTypes)` Gets the award requirement form for creating new credential requirements.
`AwardRequirementForm`	`getAwardRequirementFormForUpdate(Id awardRequirementId)` Gets the award requirement form for updating an existing credential requirement.
`CourseCatalog`	`getCourseCatalog()` Gets the `CourseCatalog` associated with this session.
`Id`	`getCourseCatalogId()` Gets the `CourseCatalog` `Id` associated with this session.
`CourseRequirementForm`	`getCourseRequirementFormForCreate(Id courseId, Type[] courseRequirementRecordTypes)` Gets the course requirement form for creating new course requirements.
`CourseRequirementForm`	`getCourseRequirementFormForUpdate(Id courseRequirementId)` Gets the course requirement form for updating an existing course requirement.
`CredentialRequirementForm`	`getCredentialRequirementFormForCreate(Id credentialId, Type[] credentialRequirementRecordTypes)` Gets the credential requirement form for creating new credential requirements.
`CredentialRequirementForm`	`getCredentialRequirementFormForUpdate(Id credentialRequirementId)` Gets the credential requirement form for updating an existing credential requirement.
`LearningObjectiveRequirementForm`	`getLearningObjectiveRequirementFormForCreate(Id objectiveId, Type[] learningObjectiveRequirementForm)` Gets the learning objective requirement form for creating new learning objective requirements.
`LearningObjectiveRequirementForm`	`getLearningObjectiveRequirementFormForUpdate(Id learningObjectiveRequirementId)` Gets the learning objective requirement form for updating an existing learning objective requirement.
`ProgramRequirementForm`	`getProgramRequirementFormForCreate(Id programId, Type[] programRequirementRecordTypes)` Gets the program requirement form for creating new program requirements.
`ProgramRequirementForm`	`getProgramRequirementFormForUpdate(Id programRequirementId)` Gets the program requirement form for updating an existing program requirement.
`RequisiteForm`	`getRequisiteFormForCreate(Type[] requisiteRecordTypes)` Gets the requisite form for creating new requisites.
`RequisiteForm`	`getRequisiteFormForUpdate(Id requisiteId)` Gets the requisite form for updating an existing requisite.
`void`	`removeAltRequisiteFromAssessmentRequirement(Id assessmentRequirementId, Id requisiteId)` Removes an alternative `Requisite` from an `AssessmentRequirement.`
`void`	`removeAltRequisiteFromAwardRequirement(Id awardRequirementId, Id requisiteId)` Removes an alternative `Requisite` from an `AwardRequirement.`
`void`	`removeAltRequisiteFromCourseRequirement(Id courseRequirementId, Id requisiteId)` Removes an alternative `Requisite` from a `CourseRequirement.`
`void`	`removeAltRequisiteFromCredentialRequirement(Id credentialRequirementId, Id requisiteId)` Removes an alternative `Requisite` from a `CredentialRequirement.`
`void`	`removeAltRequisiteFromLearningObjectiveRequirement(Id learningObjectiveRequirementId, Id requisiteId)` Removes an alternative `Requisite` from a `LearningObjectiveRequirement.`
`void`	`removeAltRequisiteFromProgramRequirement(Id programRequirementId, Id requisiteId)` Removes an alternative `Requisite` from a `ProgramRequirement.`
`void`	`removeAltRequisitesFromAssessmentRequirement(Id assessmentRequirementId)` Removes all `Requisites` from an `AssessmentRequirement.`
`void`	`removeAltRequisitesFromAwardRequirement(Id awardRequirementId)` Removes all `Requisites` from an `AwardRequirement.`
`void`	`removeAltRequisitesFromCourseRequirement(Id courseRequirementId)` Removes all `Requisites` from a `CourseRequirement.`
`void`	`removeAltRequisitesFromCredentialRequirement(Id credentialRequirementId)` Removes all `Requisites` from a `CredentialRequirement.`
`void`	`removeAltRequisitesFromLearningObjectiveRequirement(Id learningObjectiveRequirementId)` Removes all `Requisites` from a `LearningObjectiveRequirement.`
`void`	`removeAltRequisitesFromProgramRequirement(Id programRequirementId)` Removes all `Requisites` from a `ProgramRequirement.`
`void`	`removeAssessmentRequirement(Id requisiteId, Id assessmentRequirementId)` Removes anAssessment `Requirement` from a `Requisite.`
`void`	`removeAssessmentRequirements(Id requisiteId)` Removes all `AssessmentRequirements` from a `Requisite.`
`void`	`removeAwardRequirement(Id requisiteId, Id awardRequirementId)` Removes anAward `Requirement` from a `Requisite.`
`void`	`removeAwardRequirements(Id requisiteId)` Removes all `AwardRequirements` from a `Requisite.`
`void`	`removeCourseRequirement(Id requisiteId, Id courseRequirementId)` Removes a `CourseRequirement` from a `Requisite.`
`void`	`removeCourseRequirements(Id requisiteId)` Removes all `CourseRequirements` from a `Requisite.`
`void`	`removeCredentialRequirement(Id requisiteId, Id credentialRequirementId)` Removes a `CredentialRequirement` from a `Requisite.`
`void`	`removeCredentialRequirements(Id requisiteId)` Removes all `CredentialRequirements` from a `Requisite.`
`void`	`removeLearningObjectiveRequirement(Id requisiteId, Id learningObjectiveRequirementId)` Removes a `LearningObjectiveRequirement` from a `Requisite.`
`void`	`removeLearningObjectiveRequirements(Id requisiteId)` Removes all `LearningObjectiveRequirements` from a `Requisite.`
`void`	`removeProgramRequirement(Id requisiteId, Id programRequirementId)` Removes a `ProgramRequirement` from a `Requisite.`
`void`	`removeProgramRequirements(Id requisiteId)` Removes all `ProgramRequirements` from a `Requisite.`
`void`	`removeRequsiteOption(Id requisiteId, Id requisiteOptionId)` Removes a `Requisite` as an option from a `Requisite.`
`void`	`removeRequsiteOptions(Id requisiteId)` Removes all `Requisites` as options from a `Requisite.`
`void`	`updateAssessmentRequirement(Id assessmentRequirementId, AssessmentRequirementForm assessmentRequirementForm)` Updates an existing assessment requirement.
`void`	`updateAwardRequirement(Id awardRequirementId, AwardRequirementForm awardRequirementForm)` Updates an existing award requirement.
`void`	`updateCourseRequirement(Id courseRequirementId, CourseRequirementForm courseRequirementForm)` Updates an existing course requirement.
`void`	`updateCredentialRequirement(Id credentialRequirementId, CredentialRequirementForm credentialRequirementForm)` Updates an existing credential requirement.
`void`	`updateLearningObjectiveRequirement(Id learningObjectiveRequirementId, LearningObjectiveRequirementForm learningObjectiveRequirementForm)` Updates an existing learning objective requirement.
`void`	`updateProgramRequirement(Id programRequirementId, ProgramRequirementForm programRequirementForm)` Updates an existing program requirement.
`void`	`updateRequisite(RequisiteForm requisiteForm)` Updates an existing requisite.

Methods inherited from interface org.osid.OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession
close

Methods inherited from interface java.io.Closeable
close

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

Interface RequisiteAdminSession

Method Summary

Methods inherited from interface org.osid.OsidSession

Methods inherited from interface org.osid.binding.java.OsidSession

Methods inherited from interface java.io.Closeable

Method Detail

getCourseCatalogId

getCourseCatalog

canCreateRequisites

canCreateRequisiteWithRecordTypes

getRequisiteFormForCreate

createRequisite

canUpdateRequisites

getRequisiteFormForUpdate

updateRequisite

canDeleteRequisites

canDeleteRequisite

deleteRequisite

canManageRequisiteAliases

aliasRequisite

addRequsiteOption

removeRequsiteOption

removeRequsiteOptions

canCreateCourseRequirements

canCreateCourseRequirementWithRecordTypes

getCourseRequirementFormForCreate

createCourseRequirement

canUpdateCourseRequirements

canUpdateCourseRequirement

getCourseRequirementFormForUpdate

updateCourseRequirement

canDeleteCourseRequirements

canDeleteCourseRequirement

deleteCourseRequirement

deleteCourseRequirements

canManageCourseRequirementAliases

aliasCourseRequirement

addCourseRequirement

removeCourseRequirement

removeCourseRequirements

addAltRequisiteToCourseRequirement

removeAltRequisiteFromCourseRequirement

removeAltRequisitesFromCourseRequirement

canCreateProgramRequirements

canCreateProgramRequirementWithRecordTypes

getProgramRequirementFormForCreate

createProgramRequirement

canUpdateProgramRequirements

canUpdateProgramRequirement

getProgramRequirementFormForUpdate

updateProgramRequirement

canDeleteProgramRequirements

canDeleteProgramRequirement

deleteProgramRequirement

deleteProgramRequirements

canManageProgramRequirementAliases

aliasProgramRequirement

addProgramRequirement

removeProgramRequirement

removeProgramRequirements

addAltRequisiteToProgramRequirement

removeAltRequisiteFromProgramRequirement

removeAltRequisitesFromProgramRequirement

canCreateCredentialRequirements

canCreateCredentiaRequirementWithRecordTypes

getCredentialRequirementFormForCreate

createCredentialRequirement

canUpdateCredentialRequirements

canUpdateCredentialRequirement

getCredentialRequirementFormForUpdate

updateCredentialRequirement

canDeleteCredentialRequirements

canDeleteCredentialRequirement

deleteCredentialRequirement

deleteCredentialRequirements

canManageCredentialRequirementAliases

aliasCredentialRequirement

addCredentialRequirement

removeCredentialRequirement

removeCredentialRequirements