Interface | osid.provisioning.batch.ProvisioningBatchManager | ||
---|---|---|---|
Implements | osid.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:
| ||
Method | getProvisionBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.provisioning.batch.ProvisionBatchAdminSession | a ProvisionBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProvisionBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionBatchAdmin()
is true. | |
Method | getProvisionBatchAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
Return | osid.provisioning.batch.ProvisionBatchAdminSession | a ProvisionBatchAdminSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getQueueBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.provisioning.batch.QueueBatchAdminSession | a QueueBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsQueueBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsQueueBatchAdmin()
is true. | |
Method | getQueueBatchAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
Return | osid.provisioning.batch.QueueBatchAdminSession | a QueueBatchAdminSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsQueueBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getRequestBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.provisioning.batch.RequestBatchAdminSession | a RequestBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRequestBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRequestBatchAdmin()
is true. | |
Method | getRequestBatchAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
Return | osid.provisioning.batch.RequestBatchAdminSession | a RequestBatchAdminSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRequestBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getRequestTransactionBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.provisioning.batch.RequestTransactionBatchAdminSession | a RequestTransactionBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRequestTransactionBatchAdmin() is false
| ||
Compliance | optional | This method must be implemented if
supportsRequestTransactionBatchAdmin() is true. | |
Method | getRequestTransactionBatchAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
Return | osid.provisioning.batch.RequestTransactionBatchAdminSession | a RequestTransactionBatchAdminSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestTransactionBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsRequestTransactionBatchAdmin() and
supportsVisibleFederation() are true | |
Method | getPoolBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.provisioning.batch.PoolBatchAdminSession | a PoolBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsPoolBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPoolBatchAdmin()
is true. | |
Method | getPoolBatchAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
Return | osid.provisioning.batch.PoolBatchAdminSession | a PoolBatchAdminSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPoolBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getProvisionableBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.provisioning.batch.ProvisionableBatchAdminSession | a ProvisionableBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProvisionableBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionableBatchAdmin()
is true. | |
Method | getProvisionableBatchAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
Return | osid.provisioning.batch.ProvisionableBatchAdminSession | a ProvisionableBatchAdminSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionableBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getBrokerBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.provisioning.batch.BrokerBatchAdminSession | a BrokerBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBrokerBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBrokerBatchAdmin()
is true. | |
Method | getBrokerBatchAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
Return | osid.provisioning.batch.BrokerBatchAdminSession | a BrokerBatchAdminSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsBrokerBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getDistributorBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.provisioning.batch.DistributorBatchAdminSession | a DistributorBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDistributorBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDistributorBatchAdmin()
is true. |