Interface LearningBatchManager

All Superinterfaces:
AutoCloseable, Closeable, LearningBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface LearningBatchManager extends OsidManager, LearningBatchProfile

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

  • ObjectiveBatchAdminSession : a session to create, modify and delete availabilities in bulk
  • ActivityBatchAdminSession : a session to create, modify and delete activities in bulk
  • ProficiencyBatchAdminSession : a session to create, modify and delete proficiencies in bulk
  • ObjectiveBankBatchAdminSession : a session to create, modify and delete objective banks in bulk

  • Method Details

    • getObjectiveBatchAdminSession

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

    • getObjectiveBatchAdminSessionForObjectiveBank

      ObjectiveBatchAdminSession getObjectiveBatchAdminSessionForObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk objective administration service for the given objective bank.
      Parameters:
      objectiveBankId - the Id of the ObjectiveBank
      Returns:
      an ObjectiveBatchAdminSession
      Throws:
      NotFoundException - no ObjectiveBank found by the given Id
      NullArgumentException - objectiveBankId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsObjectiveBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsObjectiveBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getActivityBatchAdminSession

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

    • getActivityBatchAdminSessionForObjectiveBank

      ActivityBatchAdminSession getActivityBatchAdminSessionForObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk activity administration service for the given objective bank.
      Parameters:
      objectiveBankId - the Id of the ObjectiveBank
      Returns:
      an ActivityBatchAdminSession
      Throws:
      NotFoundException - no ObjectiveBank found by the given Id
      NullArgumentException - objectiveBankId 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}

    • getProficiencyBatchAdminSession

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

    • getProficiencyBatchAdminSessionForObjectiveBank

      ProficiencyBatchAdminSession getProficiencyBatchAdminSessionForObjectiveBank(Id objectiveBankId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk proficiency administration service for the given objective bank.
      Parameters:
      objectiveBankId - the Id of the ObjectiveBank
      Returns:
      a ProficiencyBatchAdminSession
      Throws:
      NotFoundException - no ObjectiveBank found by the given Id
      NullArgumentException - objectiveBankId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProficiencyBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProficiencyBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getObjectiveBankBatchAdminSession

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