Interface CourseBatchManager

All Superinterfaces:
AutoCloseable, Closeable, CourseBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface CourseBatchManager extends OsidManager, CourseBatchProfile

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

  • CourseBatchAdminSession : a session to create, modify and delete courses in bulk
  • ActivityUnitBatchAdminSession : a session to create, modify and delete activity units in bulk
  • CourseOfferingBatchSession : a session to create, modify and delete course offerings in bulk
  • ActivityBatchAdminSession : a session to create, modify and delete activities in bulk
  • TermBatchAdminSession : a session to create, modify and delete terms in bulk
  • CourseCatalogBatchAdminSession : a session to create, modify and delete course catalogs in bulk

  • Method Details

    • getCourseBatchAdminSession

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

    • getCourseBatchAdminSessionForCourseCatalog

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

    • getActivityUnitBatchAdminSession

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

    • getActivityUnitBatchAdminSessionForCourseCatalog

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

    • getCourseOfferingBatchAdminSession

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

    • getCourseOfferingBatchAdminSessionForCourseCatalog

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

    • getActivityBatchAdminSession

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

    • getActivityBatchAdminSessionForCourseCatalog

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

    • getTermBatchAdminSession

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

    • getTermBatchAdminSessionForCourseCatalog

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

    • getCourseCatalogBatchAdminSession

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