OSID Logo
OSID Specifications
provisioning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.batch.ProvisioningBatchManager
Implementsosid.OsidManager
osid.provisioning.batch.ProvisioningBatchProfile
Description

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

  • ProvisionBatchAdminSession: a session to create, modify and delete provisions in bulk
  • QueueBatchSession: a session to create, modify and delete queues in bulk
  • RequestBatchAdminSession: a session to create, modify and delete requests in bulk
  • RequestBatchAdminSession: a session to create, modify and delete request transactionss in bulk
  • PoolBatchAdminSession: a session to create, modify and delete pools in bulk
  • ProvisionableBatchAdminSession: a session to create, modify and delete provisionables in bulk
  • BrokerBatchAdminSession: a session to create, modify and delete brokers in bulk
  • DistributorBatchAdminSession: a session to create, modify and delete distributors in bulk
MethodgetProvisionBatchAdminSession
Description

Gets the OsidSession associated with the bulk provision administration service.

Returnosid.provisioning.batch.ProvisionBatchAdminSessiona ProvisionBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProvisionBatchAdmin() is true.
MethodgetProvisionBatchAdminSessionForDistributor
Description

Gets the OsidSession associated with the bulk provision administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.batch.ProvisionBatchAdminSessiona ProvisionBatchAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionBatchAdmin() and supportsVisibleFederation() are true
MethodgetQueueBatchAdminSession
Description

Gets the OsidSession associated with the bulk queue administration service.

Returnosid.provisioning.batch.QueueBatchAdminSessiona QueueBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsQueueBatchAdmin() is true.
MethodgetQueueBatchAdminSessionForDistributor
Description

Gets the OsidSession associated with the bulk queue administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.batch.QueueBatchAdminSessiona QueueBatchAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQueueBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueBatchAdmin() and supportsVisibleFederation() are true
MethodgetRequestBatchAdminSession
Description

Gets the OsidSession associated with the bulk request administration service.

Returnosid.provisioning.batch.RequestBatchAdminSessiona RequestBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRequestBatchAdmin() is true.
MethodgetRequestBatchAdminSessionForDistributor
Description

Gets the OsidSession associated with the bulk request administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.batch.RequestBatchAdminSessiona RequestBatchAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequestBatchAdmin() and supportsVisibleFederation() are true
MethodgetRequestTransactionBatchAdminSession
Description

Gets the OsidSession associated with the bulk request transaction administration service.

Returnosid.provisioning.batch.RequestTransactionBatchAdminSessiona RequestTransactionBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestTransactionBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRequestTransactionBatchAdmin() is true.
MethodgetRequestTransactionBatchAdminSessionForDistributor
Description

Gets the OsidSession associated with the bulk request transaction administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.batch.RequestTransactionBatchAdminSessiona RequestTransactionBatchAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRequestTransactionBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRequestTransactionBatchAdmin() and supportsVisibleFederation() are true
MethodgetPoolBatchAdminSession
Description

Gets the OsidSession associated with the bulk pool administration service.

Returnosid.provisioning.batch.PoolBatchAdminSessiona PoolBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPoolBatchAdmin() is true.
MethodgetPoolBatchAdminSessionForDistributor
Description

Gets the OsidSession associated with the bulk pool administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.batch.PoolBatchAdminSessiona PoolBatchAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPoolBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPoolBatchAdmin() and supportsVisibleFederation() are true
MethodgetProvisionableBatchAdminSession
Description

Gets the OsidSession associated with the bulk provisionable administration service.

Returnosid.provisioning.batch.ProvisionableBatchAdminSessiona ProvisionableBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableBatchAdmin() is true.
MethodgetProvisionableBatchAdminSessionForDistributor
Description

Gets the OsidSession associated with the bulk provisionable administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.batch.ProvisionableBatchAdminSessiona ProvisionableBatchAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProvisionableBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsProvisionableBatchAdmin() and supportsVisibleFederation() are true
MethodgetBrokerBatchAdminSession
Description

Gets the OsidSession associated with the bulk broker administration service.

Returnosid.provisioning.batch.BrokerBatchAdminSessiona BrokerBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBrokerBatchAdmin() is true.
MethodgetBrokerBatchAdminSessionForDistributor
Description

Gets the OsidSession associated with the bulk broker administration service for the given distributor.

Parametersosid.id.IddistributorIdthe Id of the Distributor
Returnosid.provisioning.batch.BrokerBatchAdminSessiona BrokerBatchAdminSession
ErrorsNOT_FOUNDno Distributor found by the given Id
NULL_ARGUMENT distributorId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBrokerBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBrokerBatchAdmin() and supportsVisibleFederation() are true
MethodgetDistributorBatchAdminSession
Description

Gets the OsidSession associated with the bulk distributor administration service.

Returnosid.provisioning.batch.DistributorBatchAdminSessiona DistributorBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDistributorBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDistributorBatchAdmin() is true.