| Interface | osid.resourcing.batch.ResourcingBatchProxyManager | ||
|---|---|---|---|
| Implements | osid.OsidProxyManager | ||
osid.resourcing.batch.ResourcingBatchProfile | |||
| Description |
The resourcing batch proxy manager provides access to
resourcing batch sessions and provides interoperability tests
for various aspects of this service. Methods in this manager
support the passing of a
| ||
| Method | getJobBatchAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.resourcing.batch.JobBatchAdminSession | a JobBatchAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsJobBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsJobBatchAdmin()
is true. | |
| Method | getJobBatchAdminSessionForFoundry | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | foundryId | the Id of the Foundry |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resourcing.batch.JobBatchAdminSession | a JobBatchAdminSession | |
| Errors | NOT_FOUND | no Foundry found by the given Id | |
| NULL_ARGUMENT | foundryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsJobBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsJobBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getWorkBatchAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.resourcing.batch.WorkBatchAdminSession | a WorkBatchAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsWorkBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsWorkBatchAdmin()
is true. | |
| Method | getWorkBatchAdminSessionForFoundry | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | foundryId | the Id of the Foundry |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resourcing.batch.WorkBatchAdminSession | a WorkBatchAdminSession | |
| Errors | NOT_FOUND | no Foundry found by the given Id | |
| NULL_ARGUMENT | foundryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsWorkBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsWorkBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getCompetencyBatchAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.resourcing.batch.CompetencyBatchAdminSession | a CompetencyBatchAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCompetencyBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsCompetencyBatchAdmin()
is true. | |
| Method | getCompetencyBatchAdminSessionForFoundry | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | foundryId | the Id of the Foundry |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resourcing.batch.CompetencyBatchAdminSession | a CompetencyBatchAdminSession | |
| Errors | NOT_FOUND | no Foundry found by the given Id | |
| NULL_ARGUMENT | foundryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCompetencyBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCompetencyBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getAvailabilityBatchAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.resourcing.batch.AvailabilityBatchAdminSession | an AvailabilityBatchAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAvailabilityBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsAvailabilityBatchAdmin()
is true. | |
| Method | getAvailabilityBatchAdminSessionForFoundry | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | foundryId | the Id of the Foundry |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resourcing.batch.AvailabilityBatchAdminSession | an AvailabilityBatchAdminSession | |
| Errors | NOT_FOUND | no Foundry found by the given Id | |
| NULL_ARGUMENT | foundryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAvailabilityBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAvailabilityBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getCommissionBatchAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.resourcing.batch.CommissionBatchAdminSession | a CommissionBatchAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCommissionBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsCommissionBatchAdmin()
is true. | |
| Method | getCommissionBatchAdminSessionForFoundry | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | foundryId | the Id of the Foundry |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resourcing.batch.CommissionBatchAdminSession | a CommissionBatchAdminSession | |
| Errors | NOT_FOUND | no Foundry found by the given Id | |
| NULL_ARGUMENT | foundryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsCommissionBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsCommissionBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getEffortBatchAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.resourcing.batch.EffortBatchAdminSession | an EffortBatchAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEffortBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsEffortBatchAdmin()
is true. | |
| Method | getEffortBatchAdminSessionForFoundry | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | foundryId | the Id of the Foundry |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.resourcing.batch.EffortBatchAdminSession | an EffortBatchAdminSession | |
| Errors | NOT_FOUND | no Foundry found by the given Id | |
| NULL_ARGUMENT | foundryId or proxy is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEffortBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsEffortBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getFoundryBatchAdminSession | ||
| Description |
Gets the | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.resourcing.batch.FoundryBatchAdminSession | a FoundryBatchAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsFoundryBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsFoundryBatchAdmin()
is true. | |