OSID Logo
OSID Specifications
offering batch package
Version 3.1.0
Interfaceosid.offering.batch.OfferingBatchProxyManager
Implementsosid.OsidProxyManager
osid.offering.batch.OfferingBatchProfile
Used Byosid.offering.OfferingProxyManager
Description

The offering batch proxy manager provides access to offering 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:

  • 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.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.offering.batch.CanonicalUnitBatchAdminSession a CanonicalUnitBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCanonicalUnitBatchAdmin() is false
Complianceoptional This 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.IdcatalogueId the Id of the Catalogue
osid.proxy.Proxyproxy a proxy
Returnosid.offering.batch.CanonicalUnitBatchAdminSession a CanonicalUnitBatchAdminSession
ErrorsNOT_FOUND no Catalogue found by the given Id
NULL_ARGUMENT catalogueId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCanonicalUnitBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCanonicalUnitBatchAdmin() and supportsVisibleFederation() are true
MethodgetOfferingBatchAdminSession
Description

Gets the OsidSession associated with the bulk offering administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.offering.batch.OfferingBatchAdminSession an OfferingBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingBatchAdmin() is false
Complianceoptional This 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.IdcatalogueId the Id of the Catalogue
osid.proxy.Proxyproxy a proxy
Returnosid.offering.batch.OfferingBatchAdminSession an OfferingBatchAdminSession
ErrorsNOT_FOUND no Catalogue found by the given Id
NULL_ARGUMENT catalogueId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsOfferingBatchAdmin() and supportsVisibleFederation() are true
MethodgetParticipantBatchAdminSession
Description

Gets the OsidSession associated with the bulk participant administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.offering.batch.ParticipantBatchAdminSession a ParticipantBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParticipantBatchAdmin() is false
Complianceoptional This 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.IdcatalogueId the Id of the Catalogue
osid.proxy.Proxyproxy a proxy
Returnosid.offering.batch.ParticipantBatchAdminSession a ParticipantBatchAdminSession
ErrorsNOT_FOUND no Catalogue found by the given Id
NULL_ARGUMENT catalogueId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParticipantBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsParticipantBatchAdmin() and supportsVisibleFederation() are true
MethodgetResultBatchAdminSession
Description

Gets the OsidSession associated with the bulk result administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.offering.batch.ResultBatchAdminSession a ResultBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResultBatchAdmin() is false
Complianceoptional This 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.IdcatalogueId the Id of the Catalogue
osid.proxy.Proxyproxy a proxy
Returnosid.offering.batch.ResultBatchAdminSession a ResultBatchAdminSession
ErrorsNOT_FOUND no Catalogue found by the given Id
NULL_ARGUMENT catalogueId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResultBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsResultBatchAdmin() and supportsVisibleFederation() are true
MethodgetCatalogueBatchAdminSession
Description

Gets the OsidSession associated with the bulk catalogue administration service.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.offering.batch.CatalogueBatchAdminSession a CatalogueBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCatalogueBatchAdmin() is false
Complianceoptional This method must be implemented if supportsCatalogueBatchAdmin() is true.