OSID Logo
OSID Specifications
tracking batch package
Version 3.0.0
Release Candidate Preview
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.IssueBatchAdminSessiona IssueBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIssueBatchAdmin() is false
ComplianceoptionalThis 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.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.batch.IssueBatchAdminSessiona IssueBatchAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIssueBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.SubtaskIssueBatchAdminSessiona SubtaskBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubtaskBatchAdmin() is false
ComplianceoptionalThis 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.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.batch.SubtaskIssueBatchAdminSessiona SubtaskBatchAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubtaskBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.QueueBatchAdminSessiona QueueBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueBatchAdmin() is false
ComplianceoptionalThis 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.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.batch.QueueBatchAdminSessiona QueueBatchAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.FrontOfficeBatchAdminSessiona FrontOfficeBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFrontOfficeBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFrontOfficeBatchAdmin() is true.