OSID Logo
OSID Specifications
hold batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.batch.HoldBatchManager
Implementsosid.OsidManager
osid.hold.batch.HoldBatchProfile
Description

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

  • BlockBatchAdminSession: a session to create, modify and delete blocks in bulk
  • IssueBatchSession: a session to create, modify and delete issues in bulk
  • HoldBatchAdminSession: a session to create, modify and delete holds in bulk
  • OublietteBatchAdminSession: a session to create, modify and delete oubliettes in bulk
MethodgetBlockBatchAdminSession
Description

Gets the OsidSession associated with the bulk block administration service.

Returnosid.hold.batch.BlockBatchAdminSessiona BlockBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBlockBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBlockBatchAdmin() is true.
MethodgetBlockBatchAdminSessionForOubliette
Description

Gets the OsidSession associated with the bulk block administration service for the given oubliette.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette
Returnosid.hold.batch.BlockBatchAdminSessiona BlockBatchAdminSession
ErrorsNOT_FOUNDno Oubliette found by the given Id
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBlockBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBlockBatchAdmin() and supportsVisibleFederation() are true
MethodgetIssueBatchAdminSession
Description

Gets the OsidSession associated with the bulk issue administration service.

Returnosid.hold.batch.IssueBatchAdminSessionan IssueBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIssueBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsIssueBatchAdmin() is true.
MethodgetIssueBatchAdminSessionForOubliette
Description

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

Parametersosid.id.IdoublietteIdthe Id of the Oubliette
Returnosid.hold.batch.IssueBatchAdminSessionan IssueBatchAdminSession
ErrorsNOT_FOUNDno Oubliette found by the given Id
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIssueBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIssueBatchAdmin() and supportsVisibleFederation() are true
MethodgetHoldBatchAdminSession
Description

Gets the OsidSession associated with the bulk hold administration service.

Returnosid.hold.batch.HoldBatchAdminSessiona HoldBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsHoldBatchAdmin() is true.
MethodgetHoldBatchAdminSessionForOubliette
Description

Gets the OsidSession associated with the bulk hold administration service for the given oubliette.

Parametersosid.id.IdoublietteIdthe Id of the Oubliette
Returnosid.hold.batch.HoldBatchAdminSessiona HoldBatchAdminSession
ErrorsNOT_FOUNDno Oubliette found by the given Id
NULL_ARGUMENT oublietteId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsHoldBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsHoldBatchAdmin() and supportsVisibleFederation() are true
MethodgetOublietteBatchAdminSession
Description

Gets the OsidSession associated with the bulk oubliette administration service.

Returnosid.hold.batch.OublietteBatchAdminSessiona OublietteBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOublietteBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsOublietteBatchAdmin() is true.