Interface CourseProgramBatchManager

All Superinterfaces:
AutoCloseable, Closeable, CourseProgramBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface CourseProgramBatchManager extends OsidManager, CourseProgramBatchProfile

The course program batch manager provides access to course program batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • ProgramBatchAdminSession : a session to create, modify and delete programs in bulk
  • ProgramOfferingBatchAdminSession : a session to create, modify and delete program offerings in bulk
  • CredentialBatchAdminSession : a session to create, modify and delete cerdentials in bulk
  • EnrollmentBatchAdminSession : a session to create, modify and delete enrollments in bulk

  • Method Details

    • getProgramBatchAdminSession

      ProgramBatchAdminSession getProgramBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk program administration service.
      Returns:
      a ProgramBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramBatchAdmin()} is {@code true} .

    • getProgramBatchAdminSessionForCourseCatalog

      ProgramBatchAdminSession getProgramBatchAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk program administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a ProgramBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getProgramOfferingBatchAdminSession

      ProgramOfferingBatchAdminSession getProgramOfferingBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk program offering administration service.
      Returns:
      a ProgramOfferingBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramOfferingBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramOfferingBatchAdmin()} is {@code true} .

    • getProgramOfferingBatchAdminSessionForCourseCatalog

      ProgramOfferingBatchAdminSession getProgramOfferingBatchAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk program offering administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a ProgramOfferingBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProgramOfferingBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramOfferingBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getCredentialBatchAdminSession

      CredentialBatchAdminSession getCredentialBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk credential administration service.
      Returns:
      a CredentialBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCredentialBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCredentialBatchAdmin()} is {@code true} .

    • getCredentialBatchAdminSessionForCourseCatalog

      CredentialBatchAdminSession getCredentialBatchAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk credential administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      a CredentialBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCredentialBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCredentialBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getEnrollmentBatchAdminSession

      EnrollmentBatchAdminSession getEnrollmentBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk enrollment administration service.
      Returns:
      an EnrollmentBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentBatchAdmin()} is {@code true} .

    • getEnrollmentBatchAdminSessionForCourseCatalog

      EnrollmentBatchAdminSession getEnrollmentBatchAdminSessionForCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk enrollment administration service for the given course catalog.
      Parameters:
      courseCatalogId - the Id of the CourseCatalog
      Returns:
      an EnrollmentBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsEnrollmentBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEnrollmentBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}