Interface CourseRegistrationBatchProxyManager

All Superinterfaces:
AutoCloseable, Closeable, CourseRegistrationBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable
public interface CourseRegistrationBatchProxyManager extends OsidProxyManager, CourseRegistrationBatchProfile

The course registration batch proxy manager provides access to course registration batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk registration target administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a RegistrationTargetBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      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, Proxy proxy) 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
      proxy - a proxy
      Returns:
      a RegistrationTargetBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsRegistrationTargetBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationTargetBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getRegistrationBatchAdminSession

      RegistrationBatchAdminSession getRegistrationBatchAdminSession(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk registration administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a RegistrationBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      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, Proxy proxy) 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
      proxy - a proxy
      Returns:
      a RegistrationBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy 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(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk course registration administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a CourseRegistrationBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      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, Proxy proxy) 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
      proxy - a proxy
      Returns:
      a CourseRegistrationBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy 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(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk activity registration administration service.
      Parameters:
      proxy - a proxy
      Returns:
      an ActivityRegistrationBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      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, Proxy proxy) 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
      proxy - a proxy
      Returns:
      an ActivityRegistrationBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy 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}