OSID Logo
OSID Specifications
tracking batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.batch.TrackingBatchProxyManager
Implementsosid.OsidProxyManager
osid.tracking.batch.TrackingBatchProfile
Description

The tracking batch proxy manager provides access to tracking batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

  • IssueBatchAdminSession: a session to manage issues in bulk
  • SubtaskBatchAdminSession: a session to manage subtasks in bulk
  • QueueBatchAdminSession: a session to manage queued 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.tracking.batch.IssueBatchAdminSessiona IssueBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxya proxy
Returnosid.tracking.batch.IssueBatchAdminSessiona IssueBatchAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId or proxy 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 issue administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.tracking.batch.SubtaskIssueBatchAdminSessiona SubtaskIssueBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubtaskIssueBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSubtaskIssueBatchAdmin() is true.
MethodgetSubtaskIssueBatchAdminSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
osid.proxy.Proxyproxya proxy
Returnosid.tracking.batch.SubtaskIssueBatchAdminSessiona SubtaskIssueBatchAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubtaskIssueBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubtaskIssueBatchAdmin() and supportsVisibleFederation() are true
MethodgetQueueBatchAdminSession
Description

Gets the OsidSession associated with the bulk queue administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.tracking.batch.QueueBatchAdminSessiona QueueBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_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
osid.proxy.Proxyproxya proxy
Returnosid.tracking.batch.QueueBatchAdminSessiona QueueBatchAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENT frontOfficeId or proxy 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.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.tracking.batch.FrontOfficeBatchAdminSessiona FrontOfficeBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFrontOfficeBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFrontOfficeBatchAdmin() is true.