Interface CourseSyllabusBatchManager

All Superinterfaces:
AutoCloseable, Closeable, CourseSyllabusBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface CourseSyllabusBatchManager extends OsidManager, CourseSyllabusBatchProfile

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

  • SyllabusBatchSession : a session to create, modify and delete syllabi in bulk
  • ModuleBatchSession : a session to create, modify and delete cerdentials in bulk
  • DocetBatchAdminSession : a session to create, modify and delete docets in bulk

  • Method Details

    • getSyllabusBatchAdminSession

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

    • getSyllabusBatchAdminSessionForCourseCatalog

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

    • getModuleBatchAdminSession

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

    • getModuleBatchAdminSessionForCourseCatalog

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

    • getDocetBatchAdminSession

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

    • getDocetBatchAdminSessionForCourseCatalog

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