Interface CourseChronicleBatchManager

All Superinterfaces:
AutoCloseable, Closeable, CourseChronicleBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface CourseChronicleBatchManager extends OsidManager, CourseChronicleBatchProfile

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

  • ProgramEntryBatchAdminSession : a session to create, modify and delete program entries in bulk
  • CourseEntryBatchSession : a session to create, modify and delete course entries in bulk
  • CredentialEntryBatchAdminSession : a session to create, modify and delete credential entries in bulk
  • AssessmentEntryBatchAdminSession : a session to create, modify and delete assessment entries in bulk
  • AwardEntryBatchAdminSession : a session to create, modify and delete award entries in bulk

  • Method Details

    • getProgramEntryBatchAdminSession

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

    • getProgramEntryBatchAdminSessionForCourseCatalog

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

    • getCourseEntryBatchAdminSession

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

    • getCourseEntryBatchAdminSessionForCourseCatalog

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

    • getCredentialEntryBatchAdminSession

      CredentialEntryBatchAdminSession getCredentialEntryBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk credential entryadministration service.
      Returns:
      a CredentialEntryBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsCredentialEntryBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCredentialEntryBatchAdmin()} is {@code true} .

    • getCredentialEntryBatchAdminSessionForCourseCatalog

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

    • getAssessmentEntryBatchAdminSession

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

    • getAssessmentEntryBatchAdminSessionForCourseCatalog

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

    • getAwardEntryBatchAdminSession

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

    • getAwardEntryBatchAdminSessionForCourseCatalog

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