OSID Logo
OSID Specifications
offering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.batch.OfferingBatchManager
Implementsosid.OsidManager
osid.offering.batch.OfferingBatchProfile
Description

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

  • CanonicalUnitBatchAdminSession: a session to create, modify and delete canonical units in bulk
  • OfferingBatchAdminSession: a session to create, modify and delete offerings in bulk
  • ParticipantBatchSession: a session to create, modify and delete participants in bulk
  • ResultBatchAdminSession: a session to create, modify and delete results in bulk
  • CatalogueBatchAdminSession: a session to create, modify and delete catalogues in bulk
MethodgetCanonicalUnitBatchAdminSession
Description

Gets the OsidSession associated with the bulk canonical unit administration service.

Returnosid.offering.batch.CanonicalUnitBatchAdminSessiona CanonicalUnitBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCanonicalUnitBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCanonicalUnitBatchAdmin() is true.
MethodgetCanonicalUnitBatchAdminSessionForCatalogue
Description

Gets the OsidSession associated with the bulk canonical unit administration service for the given catalogue

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
Returnosid.offering.batch.CanonicalUnitBatchAdminSessiona CanonicalUnitBatchAdminSession
ErrorsNOT_FOUNDno Catalogue found by the given Id
NULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCanonicalUnitBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCanonicalUnitBatchAdmin() and supportsVisibleFederation() are true
MethodgetOfferingBatchAdminSession
Description

Gets the OsidSession associated with the bulk offering administration service.

Returnosid.offering.batch.OfferingBatchAdminSessionan OfferingBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOfferingBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsOfferingBatchAdmin() is true.
MethodgetOfferingBatchAdminSessionForCatalogue
Description

Gets the OsidSession associated with the bulk offering administration service for the given catalogue

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
Returnosid.offering.batch.OfferingBatchAdminSessionan OfferingBatchAdminSession
ErrorsNOT_FOUNDno Catalogue found by the given Id
NULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOfferingBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOfferingBatchAdmin() and supportsVisibleFederation() are true
MethodgetParticipantBatchAdminSession
Description

Gets the OsidSession associated with the bulk participant administration service.

Returnosid.offering.batch.ParticipantBatchAdminSessiona ParticipantBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParticipantBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsParticipantBatchAdmin() is true.
MethodgetParticipantBatchAdminSessionForCatalogue
Description

Gets the OsidSession associated with the bulk participant administration service for the given catalogue

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
Returnosid.offering.batch.ParticipantBatchAdminSessiona ParticipantBatchAdminSession
ErrorsNOT_FOUNDno Catalogue found by the given Id
NULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsParticipantBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsParticipantBatchAdmin() and supportsVisibleFederation() are true
MethodgetResultBatchAdminSession
Description

Gets the OsidSession associated with the bulk result administration service.

Returnosid.offering.batch.ResultBatchAdminSessiona ResultBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResultBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsResultBatchAdmin() is true.
MethodgetResultBatchAdminSessionForCatalogue
Description

Gets the OsidSession associated with the bulk result administration service for the given catalogue

Parametersosid.id.IdcatalogueIdthe Id of the Catalogue
Returnosid.offering.batch.ResultBatchAdminSessiona ResultBatchAdminSession
ErrorsNOT_FOUNDno Catalogue found by the given Id
NULL_ARGUMENT catalogueId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResultBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResultBatchAdmin() and supportsVisibleFederation() are true
MethodgetCatalogueBatchAdminSession
Description

Gets the OsidSession associated with the bulk catalogue administration service.

Returnosid.offering.batch.CatalogueBatchAdminSessiona CatalogueBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCatalogueBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCatalogueBatchAdmin() is true.