Interface RequisiteLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RequisiteLookupSession extends OsidSession

This session defines methods for retrieving requirements and requirement components.

This lookup session defines several views:

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

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

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

  • Method Details

    • 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.

    • canLookupRequisites

      boolean canLookupRequisites()
      Tests if this user can perform Requisite and component lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeRequisiteView

      void useComparativeRequisiteView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryRequisiteView

      void usePlenaryRequisiteView()
      A complete view of the Requisite returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedCourseCatalogView

      void useFederatedCourseCatalogView()
      Federates the view for methods in this session. A federated view will include requisites in catalogs which are children of this catalog in the course catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCourseCatalogView

      void useIsolatedCourseCatalogView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActiveRequisiteView

      void useActiveRequisiteView()
      Only active requisites are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusRequisiteView

      void useAnyStatusRequisiteView()
      All active and inactive requisites are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useSequesteredRequisiteView

      void useSequesteredRequisiteView()
      The returns from the lookup methods omit sequestered requisites.
      Compliance:
      mandatory - This method is must be implemented.

    • useUnsequesteredRequisiteView

      void useUnsequesteredRequisiteView()
      All requisites are returned including sequestered requisites.
      Compliance:
      mandatory - This method is must be implemented.

    • getRequisite

      Requisite getRequisite(Id requisiteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Requisite specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Requisite may have a different Id than requested, such as the case where a duplicate Id was assigned to a Requisite and retained for compatibility. In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned.
      Parameters:
      requisiteId - the Id of the Requisite to retrieve
      Returns:
      the returned requisite
      Throws:
      NotFoundException - no Requisite found with the given Id
      NullArgumentException - requisiteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesByIds

      RequisiteList getRequisitesByIds(IdList requisiteIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a RequisiteList corresponding to the given IdList . In plenary mode, the returned list contains all of the requisites specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Requisites may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned.
      Parameters:
      requisiteIds - the list of Ids to retrieve
      Returns:
      the returned RequisiteList
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - requisiteIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesByGenusType

      RequisiteList getRequisitesByGenusType(Type requisiteGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a RequisiteList corresponding to the given requisite genus Type which does not include requisites of types derived from the specified Type . In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned.
      Parameters:
      requisiteGenusType - a requisite genus type
      Returns:
      the returned RequisiteList
      Throws:
      NullArgumentException - requisiteGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesByParentGenusType

      RequisiteList getRequisitesByParentGenusType(Type requisiteGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a RequisiteList corresponding to the given requisite genus Type and include any additional requisites with genus types derived from the specified Type . In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned.
      Parameters:
      requisiteGenusType - a requisite genus type
      Returns:
      the returned RequisiteList
      Throws:
      NullArgumentException - requisiteGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesByRecordType

      RequisiteList getRequisitesByRecordType(Type requisiteRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a RequisiteList containing the given requisite record Type . In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned.
      Parameters:
      requisiteRecordType - a requisite record type
      Returns:
      the returned RequisiteList list
      Throws:
      NullArgumentException - requisiteRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesForRequisiteOption

      RequisiteList getRequisitesForRequisiteOption(Id requisiteOptionId) throws OperationFailedException, PermissionDeniedException
      Gets a RequisiteList immediately containing the given requisite option. In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned.
      Parameters:
      requisiteOptionId - a requisite option Id
      Returns:
      the returned RequisiteList
      Throws:
      NullArgumentException - requisiteOptionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisites

      RequisiteList getRequisites() throws OperationFailedException, PermissionDeniedException
      Gets all Requisites . In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, requisites are returned that are currently active. In any status mode, active and inactive requisites are returned. In sequestered mode, no sequestered requisites are returned. In unsequestered mode, all requisites are returned.
      Returns:
      a list of Requisites
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRequirement

      CourseRequirement getCourseRequirement(Id courseRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CourseRequirement specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned CourseRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to a CourseRequirement and retained for compatibility. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned.
      Parameters:
      courseRequirementId - the Id of the CourseRequirement to retrieve
      Returns:
      the returned CourseRequirement
      Throws:
      NotFoundException - no CourseRequirement found with the given Id
      NullArgumentException - courseRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRequirementsByIds

      CourseRequirementList getCourseRequirementsByIds(IdList courseRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a CourseRequirementList corresponding to the given IdList . In plenary mode, the returned list contains all of the course requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible CourseRequirements may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned.
      Parameters:
      courseRequirementIds - the list of Ids to retrieve
      Returns:
      the returned CourseRequirementList list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - courseRequirementIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRequirementsByGenusType

      CourseRequirementList getCourseRequirementsByGenusType(Type courseRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CourseRequirementList corresponding to the given course requirement genus Type which does not include course requirements of types derived from the specified Type . In plenary mode, the returned list contains all known course requirements or an error results. Otherwise, the returned list may contain only those course requirements that are accessible through this session. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned.
      Parameters:
      courseRequirementGenusType - a course requirement genus type
      Returns:
      the returned CourseRequirementList
      Throws:
      NullArgumentException - courseRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRequirementsByParentGenusType

      CourseRequirementList getCourseRequirementsByParentGenusType(Type courseRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CourseRequirementList corresponding to the given course requirement genus Type and include any additional course requirements with genus types derived from the specified Type . In plenary mode, the returned list contains all known course requirements or an error results. Otherwise, the returned list may contain only those course requirements that are accessible through this session. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned.
      Parameters:
      courseRequirementGenusType - a course requirements genus type
      Returns:
      the returned CourseRequirementList
      Throws:
      NullArgumentException - courseRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRequirementsByRecordType

      CourseRequirementList getCourseRequirementsByRecordType(Type courseRequirementRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a CourseRequirementList containing the given course requirement record Type . In plenary mode, the returned list contains all known course requirements or an error results. Otherwise, the returned list may contain only those course requirements that are accessible through this session. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned.
      Parameters:
      courseRequirementRecordType - a course requirement record type
      Returns:
      the returned CourseRequirementList
      Throws:
      NullArgumentException - courseRequirementRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRequirementsByCourse

      CourseRequirementList getCourseRequirementsByCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
      Gets a CourseRequirementList containing the given course. In plenary mode, the returned list contains all known course requirements or an error results. Otherwise, the returned list may contain only those course requirements that are accessible through this session. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned.
      Parameters:
      courseId - a course Id
      Returns:
      the returned CourseRequirementList
      Throws:
      NullArgumentException - courseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRequirementsByAltRequisite

      CourseRequirementList getCourseRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
      Gets a CourseRequirementList with the given Requisite . In plenary mode, the returned list contains all known course requirements or an error results. Otherwise, the returned list may contain only those course requirements that are accessible through this session. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned.
      Parameters:
      requisiteId - a requisite Id
      Returns:
      the returned CourseRequirementList
      Throws:
      NullArgumentException - requisiteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesForCourseRequirement

      RequisiteList getRequisitesForCourseRequirement(Id courseRequirementId) throws OperationFailedException, PermissionDeniedException
      Gets a RequisiteList immediately containing the given course requirement. In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, course requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive requisites are returned.
      Parameters:
      courseRequirementId - a course requirement Id
      Returns:
      the returned RequisiteList
      Throws:
      NullArgumentException - courseRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRequirements

      CourseRequirementList getCourseRequirements() throws OperationFailedException, PermissionDeniedException
      Gets all CourseRequirements . In plenary mode, the returned list contains all known course requirements or an error results. Otherwise, the returned list may contain only those course requirements that are accessible through this session. In active mode, course requirements are returned that are currently active. In any status mode, active and inactive course requirements are returned.
      Returns:
      a list of CourseRequirements
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProgramRequirement

      ProgramRequirement getProgramRequirement(Id programRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the ProgramRequirement specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ProgramRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to a ProgramRequirement and retained for compatibility. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned.
      Parameters:
      programRequirementId - the Id of the ProgramRequirement to retrieve
      Returns:
      the returned ProgramRequirement
      Throws:
      NotFoundException - no ProgramRequirement found with the given Id
      NullArgumentException - programRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProgramRequirementsByIds

      ProgramRequirementList getProgramRequirementsByIds(IdList programRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a ProgramRequirementList corresponding to the given IdList . In plenary mode, the returned list contains all of the program requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible ProgramRequirements may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned.
      Parameters:
      programRequirementIds - the list of Ids to retrieve
      Returns:
      the returned ProgramRequirementList list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - programRequirementIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProgramRequirementsByGenusType

      ProgramRequirementList getProgramRequirementsByGenusType(Type programRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a ProgramRequirementList corresponding to the given program requirement genus Type which does not include program requirements of types derived from the specified Type . In plenary mode, the returned list contains all known program requirements or an error results. Otherwise, the returned list may contain only those program requirements that are accessible through this session. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned.
      Parameters:
      programRequirementGenusType - a program requirement genus type
      Returns:
      the returned ProgramRequirementList
      Throws:
      NullArgumentException - programRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProgramRequirementsByParentGenusType

      ProgramRequirementList getProgramRequirementsByParentGenusType(Type programRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a ProgramRequirementList corresponding to the given program requirement genus Type and include any additional program requirements with genus types derived from the specified Type . In plenary mode, the returned list contains all known program requirements or an error results. Otherwise, the returned list may contain only those program requirements that are accessible through this session. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned.
      Parameters:
      programRequirementGenusType - a program requirements genus type
      Returns:
      the returned ProgramRequirementList
      Throws:
      NullArgumentException - programRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProgramRequirementsByRecordType

      ProgramRequirementList getProgramRequirementsByRecordType(Type programRequirementRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a ProgramRequirementList containing the given program requirement record Type . In plenary mode, the returned list contains all known program requirements or an error results. Otherwise, the returned list may contain only those program requirements that are accessible through this session. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned.
      Parameters:
      programRequirementRecordType - a program requirement record type
      Returns:
      the returned ProgramRequirementList
      Throws:
      NullArgumentException - programRequirementRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProgramRequirementsByProgram

      ProgramRequirementList getProgramRequirementsByProgram(Id programId) throws OperationFailedException, PermissionDeniedException
      Gets a ProgramRequirementList containing the given program. In plenary mode, the returned list contains all known program requirements or an error results. Otherwise, the returned list may contain only those program requirements that are accessible through this session. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned.
      Parameters:
      programId - a program Id
      Returns:
      the returned ProgramRequirementList
      Throws:
      NullArgumentException - programId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProgramRequirementsByAltRequisite

      ProgramRequirementList getProgramRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
      Gets a ProgramRequirementList with the given Requisite . In plenary mode, the returned list contains all known program requirements or an error results. Otherwise, the returned list may contain only those program requirements that are accessible through this session. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned.
      Parameters:
      requisiteId - a requisite Id
      Returns:
      the returned ProgramRequirementList
      Throws:
      NullArgumentException - requisiteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesForProgramRequirement

      RequisiteList getRequisitesForProgramRequirement(Id programRequirementId) throws OperationFailedException, PermissionDeniedException
      Gets a RequisiteList immediately containing the given program requirement. In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, program requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive requisites are returned.
      Parameters:
      programRequirementId - a program requirement Id
      Returns:
      the returned RequisiteList
      Throws:
      NullArgumentException - programRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProgramRequirements

      ProgramRequirementList getProgramRequirements() throws OperationFailedException, PermissionDeniedException
      Gets all ProgramRequirements . In plenary mode, the returned list contains all known program requirements or an error results. Otherwise, the returned list may contain only those program requirements that are accessible through this session. In active mode, program requirements are returned that are currently active. In any status mode, active and inactive program requirements are returned.
      Returns:
      a list of ProgramRequirements
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialRequirement

      CredentialRequirement getCredentialRequirement(Id credentialRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CredentialRequirement specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned CredentialRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to a CredentialRequirement and retained for compatibility. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned.
      Parameters:
      credentialRequirementId - the Id of the CredentialRequirement to retrieve
      Returns:
      the returned CredentialRequirement
      Throws:
      NotFoundException - no CredentialRequirement found with the given Id
      NullArgumentException - credentialRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialRequirementsByIds

      CredentialRequirementList getCredentialRequirementsByIds(IdList credentialRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a CredentialRequirementList corresponding to the given IdList . In plenary mode, the returned list contains all of the credential requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible CredentialRequirements may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned.
      Parameters:
      credentialRequirementIds - the list of Ids to retrieve
      Returns:
      the returned CredentialRequirementList list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - credentialRequirementIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialRequirementsByGenusType

      CredentialRequirementList getCredentialRequirementsByGenusType(Type credentialRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CredentialRequirementList corresponding to the given credential requirement genus Type which does not include credential requirements of types derived from the specified Type . In plenary mode, the returned list contains all known credential requirements or an error results. Otherwise, the returned list may contain only those credential requirements that are accessible through this session. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned.
      Parameters:
      credentialRequirementGenusType - a credential requirement genus type
      Returns:
      the returned CredentialRequirementList
      Throws:
      NullArgumentException - credentialRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialRequirementsByParentGenusType

      CredentialRequirementList getCredentialRequirementsByParentGenusType(Type credentialRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CredentialRequirementList corresponding to the given credential requirement genus Type and include any additional credential requirements with genus types derived from the specified Type . In plenary mode, the returned list contains all known credential requirements or an error results. Otherwise, the returned list may contain only those credential requirements that are accessible through this session. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned.
      Parameters:
      credentialRequirementGenusType - a credential requirements genus type
      Returns:
      the returned CredentialRequirementList
      Throws:
      NullArgumentException - credentialRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialRequirementsByRecordType

      CredentialRequirementList getCredentialRequirementsByRecordType(Type credentialRequirementRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a CredentialRequirementList containing the given credential requirement record Type . In plenary mode, the returned list contains all known credential requirements or an error results. Otherwise, the returned list may contain only those credential requirements that are accessible through this session. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned.
      Parameters:
      credentialRequirementRecordType - a credential requirement record type
      Returns:
      the returned CredentialRequirementList
      Throws:
      NullArgumentException - credentialRequirementRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialRequirementsByCredential

      CredentialRequirementList getCredentialRequirementsByCredential(Id credentialId) throws OperationFailedException, PermissionDeniedException
      Gets a CredentialRequirementList containing the given credential. In plenary mode, the returned list contains all known credential requirements or an error results. Otherwise, the returned list may contain only those credential requirements that are accessible through this session. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned.
      Parameters:
      credentialId - a credential Id
      Returns:
      the returned CredentialRequirementList
      Throws:
      NullArgumentException - credentialId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialRequirementsByAltRequisite

      CredentialRequirementList getCredentialRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
      Gets a CredentialRequirementList with the given Requisite . In plenary mode, the returned list contains all known credential requirements or an error results. Otherwise, the returned list may contain only those credential requirements that are accessible through this session. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned.
      Parameters:
      requisiteId - a requisite Id
      Returns:
      the returned CredentialRequirementList
      Throws:
      NullArgumentException - requisiteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesForCredentialRequirement

      RequisiteList getRequisitesForCredentialRequirement(Id credentialRequirementId) throws OperationFailedException, PermissionDeniedException
      Gets a RequisiteList immediately containing the given credential requirement. In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, credential requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive requisites are returned.
      Parameters:
      credentialRequirementId - a credential requirement Id
      Returns:
      the returned RequisiteList
      Throws:
      NullArgumentException - credentialRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialRequirements

      CredentialRequirementList getCredentialRequirements() throws OperationFailedException, PermissionDeniedException
      Gets all CredentialRequirements . In plenary mode, the returned list contains all known credential requirements or an error results. Otherwise, the returned list may contain only those credential requirements that are accessible through this session. In active mode, credential requirements are returned that are currently active. In any status mode, active and inactive credential requirements are returned.
      Returns:
      a list of CredentialRequirements
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveRequirement

      LearningObjectiveRequirement getLearningObjectiveRequirement(Id learningObjectiveRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the LearningObjectiveRequirement specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned LearningObjectiveRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to a LearningObjectiveRequirement and retained for compatibility. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned.
      Parameters:
      learningObjectiveRequirementId - the Id of the LearningObjectiveRequirement to retrieve
      Returns:
      the returned LearningObjectiveRequirement
      Throws:
      NotFoundException - no LearningObjectiveRequirement found with the given Id
      NullArgumentException - learningObjectiveRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveRequirementsByIds

      LearningObjectiveRequirementList getLearningObjectiveRequirementsByIds(IdList learningObjectiveRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a LearningObjectiveRequirementList corresponding to the given IdList . In plenary mode, the returned list contains all of the learning objective requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible LearningObjectiveRequirements may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned.
      Parameters:
      learningObjectiveRequirementIds - the list of Ids to retrieve
      Returns:
      the returned LearningObjectiveRequirement list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - learningObjectiveRequirementIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveRequirementsByGenusType

      LearningObjectiveRequirementList getLearningObjectiveRequirementsByGenusType(Type learningObjectiveRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a LearningObjectiveRequirementList corresponding to the given learning objective requirement genus Type which does not include learning objective requirements of types derived from the specified Type . In plenary mode, the returned list contains all known learning objective requirements or an error results. Otherwise, the returned list may contain only those learning objective requirements that are accessible through this session. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned.
      Parameters:
      learningObjectiveRequirementGenusType - a learning objective requirement genus type
      Returns:
      the returned LearningObjectiveRequirementList
      Throws:
      NullArgumentException - learningObjectiveRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveRequirementsByParentGenusType

      LearningObjectiveRequirementList getLearningObjectiveRequirementsByParentGenusType(Type learningObjectiveRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a LearningObjectiveRequirementList corresponding to the given learning objective requirement genus Type and include any additional learning objective requirements with genus types derived from the specified Type . In plenary mode, the returned list contains all known learning objective requirements or an error results. Otherwise, the returned list may contain only those learning objective requirements that are accessible through this session. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned.
      Parameters:
      learningObjectiveRequirementGenusType - a learning objective requirements genus type
      Returns:
      the returned LearningObjectiveRequirementList
      Throws:
      NullArgumentException - learningObjectiveRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveRequirementsByRecordType

      LearningObjectiveRequirementList getLearningObjectiveRequirementsByRecordType(Type learningObjectiveRequirementRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a LearningObjectiveRequirementList containing the given learning objective requirement record Type . In plenary mode, the returned list contains all known learning objective requirements or an error results. Otherwise, the returned list may contain only those learning objective requirements that are accessible through this session. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned.
      Parameters:
      learningObjectiveRequirementRecordType - a learning objective requirement record type
      Returns:
      the returned LearningObjectiveRequirementList
      Throws:
      NullArgumentException - learningObjectiverequirementRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveRequirementsByObjective

      LearningObjectiveRequirementList getLearningObjectiveRequirementsByObjective(Id objectiveId) throws OperationFailedException, PermissionDeniedException
      Gets a LearningObjectiveRequirementList containing the given learning objective. In plenary mode, the returned list contains all known learning objective requirements or an error results. Otherwise, the returned list may contain only those learning objective requirements that are accessible through this session. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned.
      Parameters:
      objectiveId - a learning objective Id
      Returns:
      the returned LearningObjectiveRequirementList
      Throws:
      NullArgumentException - objectiveId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveRequirementsByAltRequisite

      LearningObjectiveRequirementList getLearningObjectiveRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
      Gets a LearningObjectiveRequirementList with the given Requisite . In plenary mode, the returned list contains all known learning objective requirements or an error results. Otherwise, the returned list may contain only those learning objective requirements that are accessible through this session. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned.
      Parameters:
      requisiteId - a requisite Id
      Returns:
      the returned LearningObjectiveRequirementList
      Throws:
      NullArgumentException - requisiteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesForLearningObjectiveRequirement

      RequisiteList getRequisitesForLearningObjectiveRequirement(Id learningObjectiveRequirementId) throws OperationFailedException, PermissionDeniedException
      Gets a RequisiteList immediately containing the given learning objective requirement. In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, learning objective requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive requirements are returned.
      Parameters:
      learningObjectiveRequirementId - a learning objective requirement Id
      Returns:
      the returned RequisiteList
      Throws:
      NullArgumentException - learningObjectiveRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectiveRequirements

      LearningObjectiveRequirementList getLearningObjectiveRequirements() throws OperationFailedException, PermissionDeniedException
      Gets all LearningObjectiveRequirements . In plenary mode, the returned list contains all known learning objective requirements or an error results. Otherwise, the returned list may contain only those learning objective requirements that are accessible through this session. In active mode, learning objective requirements are returned that are currently active. In any status mode, active and inactive learning objective requirements are returned.
      Returns:
      a list of LearningObjectiveRequirements
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentRequirement

      AssessmentRequirement getAssessmentRequirement(Id assessmentRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AssessmentRequirement specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AssessmentRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to an AssessmentRequirement and retained for compatibility. In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned.
      Parameters:
      assessmentRequirementId - the Id of the AssessmentRequirement to retrieve
      Returns:
      the returned AssessmentRequirement
      Throws:
      NotFoundException - no AssessmentRequirement found with the given Id
      NullArgumentException - assessmentRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentRequirementsByIds

      AssessmentRequirementList getAssessmentRequirementsByIds(IdList assessmentRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an AssessmentRequirementList corresponding to the given IdList . In plenary mode, the returned list contains all of the assessment requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AssessmentRequirements may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned.
      Parameters:
      assessmentRequirementIds - the list of Ids to retrieve
      Returns:
      a list of AssessmentRequirements
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - assessmentRequirementIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentRequirementsByGenusType

      AssessmentRequirementList getAssessmentRequirementsByGenusType(Type assessmentRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AssessmentRequirementList corresponding to the given assessment requirement genus Type which does not include assessment requirements of types derived from the specified Type . In plenary mode, the returned list contains all known assessment requirements or an error results. Otherwise, the returned list may contain only those assessment requirements that are accessible through this session. In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned.
      Parameters:
      assessmentRequirementGenusType - an assessment requirement genus type
      Returns:
      a list of AssessmentRequirements
      Throws:
      NullArgumentException - assessmentRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentRequirementsByParentGenusType

      AssessmentRequirementList getAssessmentRequirementsByParentGenusType(Type assessmentRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AssessmentRequirementList corresponding to the given assessment requirement genus Type and include any additional assessment requirements with genus types derived from the specified Type . In plenary mode, the returned list contains all known assessment requirements or an error results. Otherwise, the returned list may contain only those assessment requirements that are accessible through this session. In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned.
      Parameters:
      assessmentRequirementGenusType - an assessment requirements genus type
      Returns:
      a list of AssessmentRequirements
      Throws:
      NullArgumentException - assessmentRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentRequirementsByRecordType

      AssessmentRequirementList getAssessmentRequirementsByRecordType(Type assessmentRequirementRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an AssessmentRequirementList containing the given assessment requirement record Type . In plenary mode, the returned list contains all known assessment requirements or an error results. Otherwise, the returned list may contain only those assessment requirements that are accessible through this session. In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned.
      Parameters:
      assessmentRequirementRecordType - an assessment requirement record type
      Returns:
      a list of AssessmentRequirements
      Throws:
      NullArgumentException - assessmentRequirementRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentRequirementsByAssessment

      AssessmentRequirementList getAssessmentRequirementsByAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
      Gets an AssessmentRequirementList containing the given assessment. In plenary mode, the returned list contains all known assessment requirements or an error results. Otherwise, the returned list may contain only those assessment requirements that are accessible through this session.
      Parameters:
      assessmentId - an assessment Id
      Returns:
      a list of AssessmentRequirements
      Throws:
      NullArgumentException - assessmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentRequirementsByAltRequisite

      AssessmentRequirementList getAssessmentRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
      Gets an AssessmentRequirementList with the given Requisite . In plenary mode, the returned list contains all known assessment requirements or an error results. Otherwise, the returned list may contain only those assessment requirements that are accessible through this session. In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned.
      Parameters:
      requisiteId - a requisite Id
      Returns:
      a list of AssessmentRequirements
      Throws:
      NullArgumentException - requisiteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesForAssessmentRequirement

      RequisiteList getRequisitesForAssessmentRequirement(Id assessmentRequirementId) throws OperationFailedException, PermissionDeniedException
      Gets a RequisiteList immediately containing the given assessment requirement. In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, assessment requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive assessment requirements are returned.
      Parameters:
      assessmentRequirementId - an assessment requirement Id
      Returns:
      a list of Requisites
      Throws:
      NullArgumentException - assessmentRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentRequirements

      AssessmentRequirementList getAssessmentRequirements() throws OperationFailedException, PermissionDeniedException
      Gets all AssessmentRequirements . In plenary mode, the returned list contains all known assessment requirements or an error results. Otherwise, the returned list may contain only those assessment requirements that are accessible through this session. In active mode, assessment requirements are returned that are currently active. In any status mode, active and inactive assessment requirements are returned.
      Returns:
      a list of AssessmentRequirements
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardRequirement

      AwardRequirement getAwardRequirement(Id awardRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AwardRequirement specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AwardRequirement may have a different Id than requested, such as the case where a duplicate Id was assigned to an AwardRequirement and retained for compatibility. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned.
      Parameters:
      awardRequirementId - the Id of the AwardRequirement to retrieve
      Returns:
      the returned AwardRequirement
      Throws:
      NotFoundException - no AwardRequirement found with the given Id
      NullArgumentException - awardRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardRequirementsByIds

      AwardRequirementList getAwardRequirementsByIds(IdList awardRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an AwardRequirementList corresponding to the given IdList . In plenary mode, the returned list contains all of the award requirements specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AwardlRequirements may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned.
      Parameters:
      awardRequirementIds - the list of Ids to retrieve
      Returns:
      a list of AwardRequirements
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - awardRequirementIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardRequirementsByGenusType

      AwardRequirementList getAwardRequirementsByGenusType(Type awardRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AwardRequirementList corresponding to the given award requirement genus Type which does not include award requirements of types derived from the specified Type . In plenary mode, the returned list contains all known award requirements or an error results. Otherwise, the returned list may contain only those award requirements that are accessible through this session. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned.
      Parameters:
      awardRequirementGenusType - an award requirement genus type
      Returns:
      a list of AwardRequirements
      Throws:
      NullArgumentException - awardRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardRequirementsByParentGenusType

      AwardRequirementList getAwardRequirementsByParentGenusType(Type awardRequirementGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an AwardRequirementList corresponding to the given award requirement genus Type and include any additional award requirements with genus types derived from the specified Type . In plenary mode, the returned list contains all known award requirements or an error results. Otherwise, the returned list may contain only those award requirements that are accessible through this session. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned.
      Parameters:
      awardRequirementGenusType - an award requirements genus type
      Returns:
      a list of AwardRequirements
      Throws:
      NullArgumentException - awardRequirementGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardRequirementsByRecordType

      AwardRequirementList getAwardRequirementsByRecordType(Type awardRequirementRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an AwardRequirementList containing the given award requirement record Type . In plenary mode, the returned list contains all known award requirements or an error results. Otherwise, the returned list may contain only those award requirements that are accessible through this session. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned.
      Parameters:
      awardRequirementRecordType - an award requirement record type
      Returns:
      a list of AwardRequirements
      Throws:
      NullArgumentException - awardRequirementRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardRequirementsByAward

      AwardRequirementList getAwardRequirementsByAward(Id awardId) throws OperationFailedException, PermissionDeniedException
      Gets an AwardRequirementList containing the given award. In plenary mode, the returned list contains all known award requirements or an error results. Otherwise, the returned list may contain only those award requirements that are accessible through this session. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned.
      Parameters:
      awardId - an award Id
      Returns:
      a list of AwardRequirements
      Throws:
      NullArgumentException - awardId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardRequirementsByAltRequisite

      AwardRequirementList getAwardRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
      Gets an AwardRequirementList with the given Requisite . In plenary mode, the returned list contains all known award requirements or an error results. Otherwise, the returned list may contain only those award requirements that are accessible through this session. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned.
      Parameters:
      requisiteId - a requisite Id
      Returns:
      a list of AwardRequirements
      Throws:
      NullArgumentException - requisiteId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getRequisitesForAwardRequirement

      RequisiteList getRequisitesForAwardRequirement(Id awardRequirementId) throws OperationFailedException, PermissionDeniedException
      Gets a RequisiteList immediately containing the given award requirement. In plenary mode, the returned list contains all known requisites or an error results. Otherwise, the returned list may contain only those requisites that are accessible through this session. In active mode, award requirements are processed and requisites are returned that are currently active. In any status mode, active and inactive requisites are returned.
      Parameters:
      awardRequirementId - an award requirement Id
      Returns:
      a list of Requisites
      Throws:
      NullArgumentException - awardRequirementId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAwardRequirements

      AwardRequirementList getAwardRequirements() throws OperationFailedException, PermissionDeniedException
      Gets all AwardRequirements . In plenary mode, the returned list contains all known award requirements or an error results. Otherwise, the returned list may contain only those award requirements that are accessible through this session. In active mode, award requirements are returned that are currently active. In any status mode, active and inactive award requirements are returned.
      Returns:
      a list of AwardRequirements
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.