Interface CourseRegistrationBatchManager

All Superinterfaces:
AutoCloseable, Closeable, CourseRegistrationBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface CourseRegistrationBatchManager extends OsidManager, CourseRegistrationBatchProfile

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

  • RegistrationTargetBatchAdminSession : a session to create, modify and delete registration targets in bulk
  • RegistrationBatchSession : a session to create, modify and delete registrations in bulk
  • CourseRegistrationBatchSession : a session to create, modify and delete course registrations in bulk
  • ActivityRegistrationBatchAdminSession : a session to create, modify and delete activity registrations in bulk

  • Method Details

    • getRegistrationTargetBatchAdminSession

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

    • getRegistrationTargetBatchAdminSessionForCourseCatalog

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

    • getRegistrationBatchAdminSession

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

    • getRegistrationBatchAdminSessionForCourseCatalog

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

    • getCourseRegistrationBatchAdminSession

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

    • getCourseRegistrationBatchAdminSessionForCourseCatalog

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

    • getActivityRegistrationBatchAdminSession

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

    • getActivityRegistrationBatchAdminSessionForCourseCatalog

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