Interface TrackingBatchManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, TrackingBatchProfile
public interface TrackingBatchManager extends OsidManager, TrackingBatchProfile

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

  • IssueBatchAdminSession : a session to create, modify and delete Issues in bulk
  • SubtaskBatchAdminSession : a session to create, modify and delete Subtasks in bulk
  • QueueBatchAdminSession : a session to create, modify and delete Queues in bulk
  • FrontOfficeBatchAdminSession : a session to create, modify and delete FrontOffice in bulk

  • Method Details

    • getIssueBatchAdminSession

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

    • getIssueBatchAdminSessionForFrontOffice

      IssueBatchAdminSession getIssueBatchAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk issue administration service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a IssueBatchAdminSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsIssueBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsIssueBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getSubtaskIssueBatchAdminSession

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

    • getSubtaskIssueBatchAdminSessionForFrontOffice

      SubtaskIssueBatchAdminSession getSubtaskIssueBatchAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk subtask administration service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a SubtaskBatchAdminSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsSubtaskBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubtaskBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getQueueBatchAdminSession

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

    • getQueueBatchAdminSessionForFrontOffice

      QueueBatchAdminSession getQueueBatchAdminSessionForFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk queue administration service for the given front office.
      Parameters:
      frontOfficeId - the Id of the FrontOffice
      Returns:
      a QueueBatchAdminSession
      Throws:
      NotFoundException - no FrontOffice found by the given Id
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsQueueBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQueueBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getFrontOfficeBatchAdminSession

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