OSID Logo
OSID Specifications
financials batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.batch.FinancialsBatchManager
Implementsosid.OsidManager
osid.financials.batch.FinancialsBatchProfile
Description

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

  • AccountBatchAdminSession: a session to create, modify and delete accounts in bulk
  • ActivityBatchAdminSession: a session to create, modify and delete activities in bulk
  • FiscalPeriodBatchAdminSession: a session to create, modify and delete fiscal periods in bulk
  • BusinessBatchAdminSession: a session to create, modify and delete businesses in bulk
MethodgetAccountBatchAdminSession
Description

Gets the OsidSession associated with the bulk account administration service.

Returnosid.financials.batch.AccountBatchAdminSessionan AccountBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAccountBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAccountBatchAdmin() is true.
MethodgetAccountBatchAdminSessionForBusiness
Description

Gets the OsidSession associated with the bulk account administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.financials.batch.AccountBatchAdminSessionan AccountBatchAdminSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAccountBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAccountBatchAdmin() and supportsVisibleFederation() are true
MethodgetActivityBatchAdminSession
Description

Gets the OsidSession associated with the bulk activity administration service.

Returnosid.financials.batch.ActivityBatchAdminSessionan ActivityBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActivityBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsActivityBatchAdmin() is true.
MethodgetActivityBatchAdminSessionForBusiness
Description

Gets the OsidSession associated with the bulk activity administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.financials.batch.ActivityBatchAdminSessionan ActivityBatchAdminSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActivityBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActivityBatchAdmin() and supportsVisibleFederation() are true
MethodgetFiscalPeriodBatchAdminSession
Description

Gets the OsidSession associated with the bulk fiscal period administration service.

Returnosid.financials.batch.FiscalPeriodBatchAdminSessiona FiscalPeriodBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFiscalPeriodBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFiscalPeriodBatchAdmin() is true.
MethodgetFiscalPeriodBatchAdminSessionForBusiness
Description

Gets the OsidSession associated with the bulk fiscal period administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
Returnosid.financials.batch.FiscalPeriodBatchAdminSessiona FiscalPeriodBatchAdminSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFiscalPeriodBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFiscalPeriodBatchAdmin() and supportsVisibleFederation() are true
MethodgetBusinessBatchAdminSession
Description

Gets the OsidSession associated with the bulk business administration service.

Returnosid.financials.batch.BusinessBatchAdminSessiona BusinessBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBusinessBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBusinessBatchAdmin() is true.