Interface CourseBatchProxyManager

All Superinterfaces:
AutoCloseable, Closeable, CourseBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable
public interface CourseBatchProxyManager extends OsidProxyManager, CourseBatchProfile

The course batch proxy manager provides access to course 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:

  • 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(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk course administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a CourseBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      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, Proxy proxy) 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
      proxy - a proxy
      Returns:
      a CourseBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy 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(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk activity unit administration service.
      Parameters:
      proxy - a proxy
      Returns:
      an ActivityUnitBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      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, Proxy proxy) 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
      proxy - a proxy
      Returns:
      an ActivityUnitBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy 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(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk course offering administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a CourseOfferingBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      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, Proxy proxy) 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
      proxy - a proxy
      Returns:
      a CourseOfferingBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy 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(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk activity administration service.
      Parameters:
      proxy - a proxy
      Returns:
      an ActivityBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      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, Proxy proxy) 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
      proxy - a proxy
      Returns:
      an ActivityBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy 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(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk term administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a TermBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      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, Proxy proxy) 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
      proxy - a proxy
      Returns:
      a TermBatchAdminSession
      Throws:
      NotFoundException - no CourseCatalog found by the given Id
      NullArgumentException - courseCatalogId or proxy 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(Proxy proxy) throws OperationFailedException
      Gets the OsidSession associated with the bulk course catalog administration service.
      Parameters:
      proxy - a proxy
      Returns:
      a CourseCatalogBatchAdminSession
      Throws:
      NullArgumentException - proxy is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCourseCatalogBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseCatalogBatchAdmin()} is {@code true} .