Interface | osid.provisioning.ProvisioningProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.provisioning.ProvisioningProfile | |||
Description |
The provisioning proxy manager provides access to
provisioning sessions and provides interoperability tests for
various aspects of this service. Methods in this manager pass
a
| ||
Method | getMyProvisionSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.MyProvisionSession | a MyProvisionSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMyProvision() is false | ||
Compliance | optional | This method must be implemented if supportsMyProvision() is
true. | |
Method | getMyProvisionSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.MyProvisionSession | a MyProvisionSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMyProvision() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsMyProvision() and
supportsVisibleFederation() are true | |
Method | getMySupplierSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.MySupplierSession | a MySupplierSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMySupplier() is false | ||
Compliance | optional | This method must be implemented if supportsMySupplier() is
true. | |
Method | getMySupplierSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.MySupplierSession | a MySupplierSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMySupplier() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsMySupplier() and
supportsVisibleFederation() are true | |
Method | getMyProvisionNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.provisioning.ProvisionReceiver | provisionReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.MyProvisionNotificationSession | a MyProvisionNotificationSession | |
Errors | NULL_ARGUMENT | provisionReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMyProvisionNotification() is false | ||
Compliance | optional | This method must be implemented if supportsMyProvisionNotification()
is true. | |
Method | getMyProvisionNotificationSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.provisioning.ProvisionReceiver | provisionReceiver | the notification callback |
osid.id.Id | distributorId | the Id of the Distributor | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.MyProvisionNotificationSession | a MyProvisionNotificationSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | provisionReceiver, distributorId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMyProvisionNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsMyProvisionNotification()
and supportsVisibleFederation() are true | |
Method | getProvisionLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.ProvisionLookupSession | a ProvisionLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionLookup()
is true. | |
Method | getProvisionLookupSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.ProvisionLookupSession | a ProvisionLookupSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionLookup()
and supportsVisibleFederation() are true | |
Method | getProvisionQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.ProvisionQuerySession | a ProvisionQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionQuery()
is true. | |
Method | getProvisionQuerySessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.ProvisionQuerySession | a ProvisionQuerySession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionQuery()
and supportsVisibleFederation() are true | |
Method | getProvisionSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.ProvisionSearchSession | a ProvisionSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionSearch() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionSearch()
is true. | |
Method | getProvisionSearchSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.ProvisionSearchSession | a ProvisionSearchSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionSearch()
and supportsVisibleFederation() are true | |
Method | getProvisionAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.ProvisionAdminSession | a ProvisionAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionAdmin()
is true. | |
Method | getProvisionAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.ProvisionAdminSession | a ProvisionAdminSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionAdmin()
and supportsVisibleFederation() are true | |
Method | getProvisionNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.provisioning.ProvisionReceiver | provisionReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.ProvisionNotificationSession | a ProvisionNotificationSession | |
Errors | NULL_ARGUMENT | provisionReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionNotification() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionNotification()
is true. | |
Method | getProvisionNotificationSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.provisioning.ProvisionReceiver | provisionReceiver | the notification callback |
osid.id.Id | distributorId | the Id of the Distributor | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.ProvisionNotificationSession | a ProvisionNotificationSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | provisionReceiver, distributorId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionNotification()
and supportsVisibleFederation() are true | |
Method | getProvisionDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.ProvisionDistributorSession | a ProvisionDistributorSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionDistributor() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionDistributor()
is true. | |
Method | getProvisionDistributorAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.ProvisionDistributorAssignmentSession | a ProvisionDistributorAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionDistributorAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsProvisionDistributorAssignment() is true. | |
Method | getProvisionSmartDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.ProvisionDistributorSession | a ProvisionSmartDistributorSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionSmartDistributor() is false | ||
Compliance | optional | This method must be implemented if
supportsProvisionSmartDistributor() is true. | |
Method | getProvisionReturnSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.ProvisionReturnSession | a ProvisionReturnSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionReturn() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionReturn()
is true. | |
Method | getProvisionReturnSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.ProvisionReturnSession | a ProvisionReturnSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy s null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionReturn() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionReturn()
and supportsVisibleFederation() are true | |
Method | getQueueLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.QueueLookupSession | a QueueLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueLookup() is false | ||
Compliance | optional | This method must be implemented if supportsQueueLookup() is
true. | |
Method | getQueueLookupSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.QueueLookupSession | a QueueLookupSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsQueueLookup() and
supportsVisibleFederation() are true | |
Method | getQueueQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.QueueQuerySession | a QueueQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueQuery() is false | ||
Compliance | optional | This method must be implemented if supportsQueueQuery() is
true. | |
Method | getQueueQuerySessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.QueueQuerySession | a QueueQuerySession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsQueueQuery() and
supportsVisibleFederation() are true | |
Method | getQueueSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.QueueSearchSession | a QueueSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueSearch() is false | ||
Compliance | optional | This method must be implemented if supportsQueueSearch() is
true. | |
Method | getQueueSearchSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.QueueSearchSession | a QueueSearchSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsQueueSearch() and
supportsVisibleFederation() are true | |
Method | getQueueAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.QueueAdminSession | a QueueAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsQueueAdmin() is
true. | |
Method | getQueueAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.QueueAdminSession | a QueueAdminSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsQueueAdmin() and
supportsVisibleFederation() are true | |
Method | getQueueNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.provisioning.QueueReceiver | queueReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.QueueNotificationSession | a QueueNotificationSession | |
Errors | NULL_ARGUMENT | queueReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueNotification() is false | ||
Compliance | optional | This method must be implemented if supportsQueueNotification()
is true. | |
Method | getQueueNotificationSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.provisioning.QueueReceiver | queueReceiver | the notification callback |
osid.id.Id | distributorId | the Id of the Distributor | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.QueueNotificationSession | a QueueNotificationSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | queueReceiver, distributorId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsQueueNotification()
and supportsVisibleFederation() are true | |
Method | getQueueDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.QueueDistributorSession | a QueueDistributorSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueDistributor() is false | ||
Compliance | optional | This method must be implemented if supportsQueueDistributor()
is true. | |
Method | getQueueDistributorAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.QueueDistributorAssignmentSession | a QueueDistributorAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueDistributorAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsQueueDistributorAssignment() is true. | |
Method | getQueueSmartDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.QueueSmartDistributorSession | a QueueSmartDistributorSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueSmartDistributor() is false | ||
Compliance | optional | This method must be implemented if supportsQueueSmartDistributor()
is true. | |
Method | getRequestLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestLookupSession | a RequestLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestLookup() is false | ||
Compliance | optional | This method must be implemented if supportsRequestLookup()
is true. | |
Method | getRequestLookupSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestLookupSession | a RequestLookupSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRequestLookup()
and supportsVisibleFederation() are true | |
Method | getRequestQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestQuerySession | a RequestQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestQuery() is false | ||
Compliance | optional | This method must be implemented if supportsRequestQuery() is
true. | |
Method | getRequestQuerySessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestQuerySession | a RequestQuerySession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRequestQuery()
and supportsVisibleFederation() are true | |
Method | getRequestSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestSearchSession | a RequestSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestSearch() is false | ||
Compliance | optional | This method must be implemented if supportsRequestSearch()
is true. | |
Method | getRequestSearchSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestSearchSession | a RequestSearchSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRequestSearch()
and supportsVisibleFederation() are true | |
Method | getRequestAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestAdminSession | a RequestAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRequestAdmin() is
true. | |
Method | getRequestAdminSessionForQueue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueId | the Id of the Queue |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestAdminSession | a RequestAdminSession | |
Errors | NOT_FOUND | no Queue found by the given Id | |
NULL_ARGUMENT | queueId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsRequestAdmin()
and supportsVisibleFederation() are true | |
Method | getRequestNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.provisioning.RequestReceiver | requestReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestNotificationSession | a RequestNotificationSession | |
Errors | NULL_ARGUMENT | requestReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestNotification() is false | ||
Compliance | optional | This method must be implemented if supportsRequestNotification()
is true. | |
Method | getRequestNotificationSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.provisioning.RequestReceiver | requestReceiver | the notification callback |
osid.id.Id | distributorId | the Id of the Distributor | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestNotificationSession | a RequestNotificationSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | requestReceiver, distributorId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRequestNotification()
and supportsVisibleFederation() are true.
| |
Method | getRequestDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestDistributorSession | a RequestDistributorSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestDistributor() is false | ||
Compliance | optional | This method must be implemented if supportsRequestyDistributor()
is true. | |
Method | getRequestDistributorAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestDistributorAssignmentSession | a RequestyDistributorAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestDistributorAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsRequestDistributorAssignment() is true. | |
Method | getRequestSmartDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestSmartDistributorSession | a RequestSmartDistributorSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestSmartDistributor() is false | ||
Compliance | optional | This method must be implemented if supportsRequestSmartDistributor()
is true. | |
Method | getRequestTransactionLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestTransactionLookupSession | a RequestTransactionLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestTransactionLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsRequestTransactionLookup() is true. | |
Method | getRequestTransactionLookupSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestTransactionLookupSession | a RequestTransactionLookupSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestTransactionLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsRequestTransactionLookup() and
supportsVisibleFederation() are true | |
Method | getRequestTransactionAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestTransactionAdminSession | a RequestTransactionAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestTransactionAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRequestTransactionAdmin()
is true. | |
Method | getRequestTransactionAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestTransactionAdminSession | a RequestTransactionAdminSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequestTransactionAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRequestTransactionAdmin()
and supportsVisibleFederation() are true | |
Method | getExchangeSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.ExchangeSession | an ExchangeSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsExchange() is false | ||
Compliance | optional | This method must be implemented if supportsExchange() is
true. | |
Method | getExchangeSessionForQueue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueId | the Id of the Queue |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.ExchangeSession | an ExchangeSession | |
Errors | NOT_FOUND | no Queue found by the given Id | |
NULL_ARGUMENT | queueId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsExchange() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsExchange() and
supportsVisibleFederation() are true | |
Method | getPoolLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.PoolLookupSession | a PoolLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolLookup() is false | ||
Compliance | optional | This method must be implemented if supportsPoolLookup() is
true. | |
Method | getPoolLookupSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.PoolLookupSession | a PoolLookupSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPoolLookup() and
supportsVisibleFederation() are true. | |
Method | getPoolQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.PoolQuerySession | a PoolQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolQuery() is false | ||
Compliance | optional | This method must be implemented if supportsPoolQuery() is
true. | |
Method | getPoolQuerySessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.PoolQuerySession | a PoolQuerySession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPoolQuery() and
supportsVisibleFederation() are true. | |
Method | getPoolSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.PoolSearchSession | a PoolSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolSearch() is false | ||
Compliance | optional | This method must be implemented if supportsPoolSearch() is
true. | |
Method | getPoolSearchSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.PoolSearchSession | a PoolSearchSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPoolSearch() and
supportsVisibleFederation() are true | |
Method | getPoolAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.PoolAdminSession | a PoolAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPoolAdmin() is
true. | |
Method | getPoolAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.PoolAdminSession | a PoolAdminSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPoolAdmin() and
supportsVisibleFederation() are true | |
Method | getPoolNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.provisioning.PoolReceiver | poolReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.PoolNotificationSession | a PoolNotificationSession | |
Errors | NULL_ARGUMENT | poolReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolNotification() is false | ||
Compliance | optional | This method must be implemented if supportsPoolNotification()
is true. | |
Method | getPoolNotificationSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.provisioning.PoolReceiver | poolReceiver | the notification callback |
osid.id.Id | distributorId | the Id of the Distributor | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.PoolNotificationSession | a PoolNotificationSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | poolReceiver, distributorId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPoolNotification()
and supportsVisibleFederation() are true.
| |
Method | getPoolDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.PoolDistributorSession | a PoolDistributorSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolDistributor() is false | ||
Compliance | optional | This method must be implemented if supportsPoolDistributor()
is true. | |
Method | getPoolDistributorAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.PoolDistributorAssignmentSession | a PoolDistributorAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolDistributorAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsPoolDistributorAssignment() is true. | |
Method | getPoolSmartDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.PoolDistributorSession | a PoolSmartDistributorSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPoolSmartDistributor() is false | ||
Compliance | optional | This method must be implemented if supportsPoolSmartDistributor()
is true. | |
Method | getProvisionableLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestLookupSession | a ProvisionableLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableLookup() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionableLookup()
is true. | |
Method | getProvisionableLookupSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestLookupSession | a ProvisionableLookupSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionableLookup()
and supportsVisibleFederation() are true.
| |
Method | getProvisionableQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestQuerySession | a ProvisionableQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableQuery() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionableQuery()
is true. | |
Method | getProvisionableQuerySessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestQuerySession | a ProvisionableQuerySession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionableQuery()
and supportsVisibleFederation() are true.
| |
Method | getProvisionableSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestSearchSession | a ProvisionableSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableSearch() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionableSearch()
is true. | |
Method | getProvisionableSearchSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestSearchSession | a ProvisionableSearchSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionableSearch()
and supportsVisibleFederation() are true.
| |
Method | getProvisionableAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestAdminSession | a ProvisionableAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionableAdmin()
is true. | |
Method | getProvisionableAdminSessionForPool | ||
Description |
Gets the | ||
Parameters | osid.id.Id | poolId | the Id of the Pool |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestAdminSession | a ProvisionableAdminSession | |
Errors | NOT_FOUND | no pool found by the given Id | |
NULL_ARGUMENT | poolId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProvisionableAdmin()
and supportsVisibleFederation() are true.
| |
Method | getProvisionableNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.provisioning.RequestReceiver | provisionableReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestNotificationSession | a ProvisionableNotificationSession | |
Errors | NULL_ARGUMENT | provisionableReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsProvisionableNotification() is true. | |
Method | getProvisionableNotificationSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.provisioning.RequestReceiver | provisionableReceiver | the notification callback |
osid.id.Id | distributorId | the Id of the Distributor | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestNotificationSession | a ProvisionableNotificationSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | provisionableReceiver, distributorId or
proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsProvisionableNotification() and
supportsVisibleFederation() are true. | |
Method | getProvisionableDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestDistributorSession | a ProvisionableDistributorSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableDistributor() is false | ||
Compliance | optional | This method must be implemented if
supportsProvisionableDistributor() is true. | |
Method | getProvisionableDistributorAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.RequestDistributorAssignmentSession | a ProvisionableDistributorAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableDistributorAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsProvisionableDistributorAssignment() is true. | |
Method | getProvisionableSmartDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.RequestSmartDistributorSession | a ProvisionableSmartDistributorSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProvisionableSmartDistributor() is false
| ||
Compliance | optional | This method must be implemented if
supportsProvisionableSmartDistributor() is true. | |
Method | getBrokerLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.BrokerLookupSession | a BrokerLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsBrokerLookup() is
true. | |
Method | getBrokerLookupSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.BrokerLookupSession | a BrokerLookupSession | |
Errors | NOT_FOUND | no Distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBrokerLookup()
and supportsVisibleFederation() are true | |
Method | getBrokerQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.BrokerQuerySession | a BrokerQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsBrokerQuery() is
true. | |
Method | getBrokerQuerySessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.BrokerQuerySession | a BrokerQuerySession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBrokerQuery() and
supportsVisibleFederation() are true | |
Method | getBrokerSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.BrokerSearchSession | a BrokerSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsBrokerSearch() is
true. | |
Method | getBrokerSearchSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.BrokerSearchSession | a BrokerSearchSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBrokerSearch()
and supportsVisibleFederation() are true | |
Method | getBrokerAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.BrokerAdminSession | a BrokerAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBrokerAdmin() is
true. | |
Method | getBrokerAdminSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.BrokerAdminSession | a BrokerAdminSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsBrokerAdmin() and
supportsVisibleFederation() are true | |
Method | getBrokerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.provisioning.BrokerReceiver | brokerReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.BrokerNotificationSession | a BrokerNotificationSession | |
Errors | NULL_ARGUMENT | brokerReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerNotification() is false | ||
Compliance | optional | This method must be implemented if supportsBrokerNotification()
is true. | |
Method | getBrokerNotificationSessionForDistributor | ||
Description |
Gets the | ||
Parameters | osid.provisioning.BrokerReceiver | brokerReceiver | the notification callback |
osid.id.Id | distributorId | the Id of the Distributor | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.BrokerNotificationSession | a BrokerNotificationSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | brokerReceiver, distributorId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsBrokerNotification()
and supportsVisibleFederation() are true | |
Method | getBrokerDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.BrokerDistributorSession | a BrokerDistributorSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerDistributor() is false | ||
Compliance | optional | This method must be implemented if supportsBrokerDistributor()
is true. | |
Method | getBrokerDistributorAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.BrokerDistributorAssignmentSession | a BrokerDistributorAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerDistributorAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsBrokerDistributorAssignment() is true. | |
Method | getBrokerSmartDistributorSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.BrokerSmartDistributorSession | a BrokerSmartDistributorSession | |
Errors | NOT_FOUND | no distributor found by the given Id | |
NULL_ARGUMENT | distributorId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBrokerSmartDistributor() is false | ||
Compliance | optional | This method must be implemented if supportsBrokerSmartDistributor()
is true. | |
Method | getDistributorLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.DistributorLookupSession | a DistributorLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDistributorLookup() is false | ||
Compliance | optional | This method must be implemented if supportsDistributorLookup()
is true. | |
Method | getDistributorQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.DistributorQuerySession | a DistributorQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDistributorQuery() is false | ||
Compliance | optional | This method must be implemented if supportsDistributorQuery()
is true. | |
Method | getDistributorSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.DistributorSearchSession | a DistributorSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDistributorSearch() is false | ||
Compliance | optional | This method must be implemented if supportsDistributorSearch()
is true. | |
Method | getDistributorAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.DistributorAdminSession | a DistributorAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDistributorAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDistributorAdmin()
is true. | |
Method | getDistributorNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.provisioning.DistributorReceiver | distributorReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.provisioning.DistributorNotificationSession | a DistributorNotificationSession | |
Errors | NULL_ARGUMENT | distributorReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDistributorNotification() is false | ||
Compliance | optional | This method must be implemented if supportsDistributorNotification()
is true. | |
Method | getDistributorHierarchySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.DistributorHierarchySession | a DistributorHierarchySession for distributors | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDistributorHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsDistributorHierarchy()
is true. | |
Method | getDistributorHierarchyDesignSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.provisioning.DistributorHierarchyDesignSession | a HierarchyDesignSession for distributors | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDistributorHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if
supportsDistributorHierarchyDesign() is true. | |
Method | getProvisioningBatchProxyManager | ||
Description |
Gets the | ||
Return | osid.provisioning.batch.ProvisioningBatchProxyManager | a ProvisioningBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProvisioningBatch() is false | ||
Compliance | optional | This method must be implemented if supportsProvisioningBatch()
is true. | |
Method | getProvisioningRulesProxyManager | ||
Description |
Gets the | ||
Return | osid.provisioning.rules.ProvisioningRulesProxyManager | a ProvisioningRulesProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProvisioningRules() is false | ||
Compliance | optional | This method must be implemented if supportsProvisioningRules()
is true. |