OSID Logo
OSID Specifications
tracking batch package
Version 3.1.0
Interfaceosid.tracking.batch.TrackingBatchManager
Implementsosid.OsidManager
osid.tracking.batch.TrackingBatchProfile
Description

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
MethodgetIssueBatchAdminSession
Description

Gets the OsidSession associated with the bulk issue administration service.

Returnosid.tracking.batch.IssueBatchAdminSession a IssueBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIssueBatchAdmin() is false
Complianceoptional This method must be implemented if supportsIssueBatchAdmin() is true.
MethodgetIssueBatchAdminSessionForFrontOffice
Description

Gets the OsidSession associated with the bulk issue administration service for the given front office.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice
Returnosid.tracking.batch.IssueBatchAdminSession a IssueBatchAdminSession
ErrorsNOT_FOUND no FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsIssueBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsIssueBatchAdmin() and supportsVisibleFederation() are true
MethodgetSubtaskIssueBatchAdminSession
Description

Gets the OsidSession associated with the bulk subtask administration service.

Returnosid.tracking.batch.SubtaskIssueBatchAdminSession a SubtaskBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubtaskBatchAdmin() is false
Complianceoptional This method must be implemented if supportsSubtaskBatchAdmin() is true.
MethodgetSubtaskIssueBatchAdminSessionForFrontOffice
Description

Gets the OsidSession associated with the bulk subtask administration service for the given front office.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice
Returnosid.tracking.batch.SubtaskIssueBatchAdminSession a SubtaskBatchAdminSession
ErrorsNOT_FOUND no FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubtaskBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsSubtaskBatchAdmin() and supportsVisibleFederation() are true
MethodgetQueueBatchAdminSession
Description

Gets the OsidSession associated with the bulk queue administration service.

Returnosid.tracking.batch.QueueBatchAdminSession a QueueBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueBatchAdmin() is false
Complianceoptional This method must be implemented if supportsQueueBatchAdmin() is true.
MethodgetQueueBatchAdminSessionForFrontOffice
Description

Gets the OsidSession associated with the bulk queue administration service for the given front office.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice
Returnosid.tracking.batch.QueueBatchAdminSession a QueueBatchAdminSession
ErrorsNOT_FOUND no FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsQueueBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsQueueBatchAdmin() and supportsVisibleFederation() are true
MethodgetFrontOfficeBatchAdminSession
Description

Gets the OsidSession associated with the bulk front office administration service.

Returnosid.tracking.batch.FrontOfficeBatchAdminSession a FrontOfficeBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFrontOfficeBatchAdmin() is false
Complianceoptional This method must be implemented if supportsFrontOfficeBatchAdmin() is true.