| Interface | osid.financials.batch.FinancialsBatchProxyManager | ||
|---|---|---|---|
| Implements | osid.OsidProxyManager | ||
osid.financials.batch.FinancialsBatchProfile | |||
| Description | 
                 The financials batch proxy manager provides access to 
                financials batch sessions and provides interoperability tests 
                for various aspects of this service. Methods in this manager 
                support the passing of a  
  | ||
| Method | getAccountBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.financials.batch.AccountBatchAdminSession | an  AccountBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsAccountBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsAccountBatchAdmin() 
 is  true.   | |
| Method | getAccountBatchAdminSessionForBusiness | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | businessId | the  Id  of the  Business   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.financials.batch.AccountBatchAdminSession | a  AccountBatchAdminSession   | |
| Errors | NOT_FOUND | no  Business  found by the given  Id   |                 |
| NULL_ARGUMENT |  businessId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsAccountBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsAccountBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getActivityBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.financials.batch.ActivityBatchAdminSession | an  ActivityBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsActivityBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsActivityBatchAdmin() 
 is  true.   | |
| Method | getActivityBatchAdminSessionForBusiness | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | businessId | the  Id  of the  Business   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.financials.batch.ActivityBatchAdminSession | an  ActivityBatchAdminSession   | |
| Errors | NOT_FOUND | no  Business  found by the given  Id   |                 |
| NULL_ARGUMENT |  businessId  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsActivityBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsActivityBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getFiscalPeriodBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.financials.batch.FiscalPeriodBatchAdminSession | a  FiscalPeriodBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsFiscalPeriodBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsFiscalPeriodBatchAdmin() 
 is  true.   | |
| Method | getFiscalPeriodBatchAdminSessionForBusiness | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | businessId | the  Id  of the  Business   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.financials.batch.FiscalPeriodBatchAdminSession | a  FiscalPeriodBatchAdminSession   | |
| Errors | NOT_FOUND | no  Business  found by the given  Id   |                 |
| NULL_ARGUMENT |  businessId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsFiscalPeriodBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsFiscalPeriodBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getBusinessBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.financials.batch.BusinessBatchAdminSession | a  BusinessBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsBusinessBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsBusinessBatchAdmin() 
 is  true.   | |