OSID - osid.financials.budgeting.FinancialsBudgetingManager Service Interface Definition

Interface	osid.financials.budgeting.FinancialsBudgetingManager
Implements	`osid.OsidManager`
Implements	`osid.financials.budgeting.FinancialsBudgetingProfile`
Description	The financials budgeting manager provides access to budgeting sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `BudgetLookupSession:` a session to retrieve budgets `BudgetQuerySession:` a session to query budgets `BudgetSearchSession:` a session to search for budgets `BudgetAdminSession:` a session to create and delete budgets `BudgetNotificationSession:` a session to receive notifications pertaining to budget changes `BudgetBusinessSession:` a session to look up budget to business mappings `BudgetBusinessAssignmentSession:` a session to manage budget to business mappings `BudgetSmartBusinessSession:` a session to manage dynamic businesses of budgets `BudgetEntryLookupSession:` a session to retrieve entries `BudgetEntryLookupSession:` a session to query entries `BudgetEntrySearchSession:` a session to search for entries `BudgetEntryAdminSession:` a session to create and delete entries `BudgetEntryNotificationSession:` a session to receive notifications pertaining to budget entry changes `BudgetEntryBusinessSession:` a session to look up budget entry to business mappings `BudgetEntryBusinessAssignmentSession:` a session to manage budget entry to business mappings `BudgetEntrySmartBusinessAssignmentSession:` a session to manage dynamic businesses of entries
Method	getBudgetLookupSession
Description	Gets the `OsidSession` associated with the budget lookup service.
Return	`osid.financials.budgeting.BudgetLookupSession`		a `BudgetSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetLookup()` is `true.`
Method	getBudgetLookupSessionForBusiness
Description	Gets the `OsidSession` associated with the budget lookup service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the business
Return	`osid.financials.budgeting.BudgetLookupSession`		a `BudgetLookupSession`
Errors	NOT_FOUND		no `Business` found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetLookup()` and `supportsVisibleFederation()` are `true`
Method	getBudgetQuerySession
Description	Gets the `OsidSession` associated with the budget query service.
Return	`osid.financials.budgeting.BudgetQuerySession`		a `BudgetQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetQuery()` is `true.`
Method	getBudgetQuerySessionForBusiness
Description	Gets the `OsidSession` associated with the budget query service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetQuerySession`		a `BudgetQuerySession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetQuery()` and `supportsVisibleFederation()` are `true`
Method	getBudgetSearchSession
Description	Gets the `OsidSession` associated with the budget search service.
Return	`osid.financials.budgeting.BudgetSearchSession`		a `BudgetSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetSearch()` is `true.`
Method	getBudgetSearchSessionForBusiness
Description	Gets the `OsidSession` associated with the budget search service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetSearchSession`		a `BudgetSearchSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetSearch()` and `supportsVisibleFederation()` are `true`
Method	getBudgetAdminSession
Description	Gets the `OsidSession` associated with the budget administration service.
Return	`osid.financials.budgeting.BudgetAdminSession`		a `BudgetAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetAdmin()` is `true.`
Method	getBudgetAdminSessionForBusiness
Description	Gets the `OsidSession` associated with the budget administration service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetAdminSession`		a `BudgetAdminSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetAdmin()` and `supportsVisibleFederation()` are `true`
Method	getBudgetNotificationSession
Description	Gets the `OsidSession` associated with the budget notification service.
Parameters	`osid.financials.budgeting.BudgetReceiver`	`budgetReceiver`	the notification callback
Return	`osid.financials.budgeting.BudgetNotificationSession`		a `BudgetNotificationSession`
Errors	NULL_ARGUMENT		`budgetReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetNotification()` is `true.`
Method	getBudgetNotificationSessionForBusiness
Description	Gets the `OsidSession` associated with the budget notification service for the given business.
Parameters	`osid.financials.budgeting.BudgetReceiver`	`budgetReceiver`	the notification callback
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetNotificationSession`		a `BudgetNotificationSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`budgetReceiver` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetNotification()` and `supportsVisibleFederation()` are `true`
Method	getBudgetBusinessSession
Description	Gets the `OsidSession` to lookup budget/catalog mappings.
Return	`osid.financials.budgeting.BudgetBusinessSession`		a `BudgetBusinessSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetBusiness()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetBusiness()` is `true.`
Method	getBudgetBusinessAssignmentSession
Description	Gets the `OsidSession` associated with assigning budgets to businesses.
Return	`osid.financials.budgeting.BudgetBusinessAssignmentSession`		a `BudgetBusinessAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetBusinessAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetBusinessAssignment()` is `true.`
Method	getBudgetSmartBusinessSession
Description	Gets the `OsidSession` associated with the budget smart business service.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetSmartBusinessSession`		a `BudgetSmartBusinessSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetSmartBusiness()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetSmartBusiness()` and `supportsVisibleFederation()` are `true`
Method	getBudgetEntryLookupSession
Description	Gets the `OsidSession` associated with the budget entry lookup service.
Return	`osid.financials.budgeting.BudgetEntryLookupSession`		a `BudgetEntryLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetEntryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryLookup()` is `true.`
Method	getBudgetEntryLookupSessionForBusiness
Description	Gets the `OsidSession` associated with the budget entry lookup service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetEntryLookupSession`		a `BudgetEntryLookupSession`
Errors	NOT_FOUND		no `Business` found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetEntryLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryLookup()` and `supportsVisibleFederation()` are `true`
Method	getBudgetEntryQuerySession
Description	Gets the `OsidSession` associated with the budget entry query service.
Return	`osid.financials.budgeting.BudgetEntryQuerySession`		a `BudgetEntryQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryQuery()` is `true.`
Method	getBudgetEntryQuerySessionForBusiness
Description	Gets the `OsidSession` associated with the budget entry query service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetEntryQuerySession`		a `BudgetEntryQuerySession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetEntryQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryQuery()` and `supportsVisibleFederation()` are `true`
Method	getBudgetEntrySearchSession
Description	Gets the `OsidSession` associated with the budget entry search service.
Return	`osid.financials.budgeting.BudgetEntrySearchSession`		a `BudgetEntrySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetEntrySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntrySearch()` is `true.`
Method	getBudgetEntrySearchSessionForBusiness
Description	Gets the `OsidSession` associated with the budget entry search service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetEntrySearchSession`		a `BudgetEntrySearchSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetEntrySearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntrySearch()` and `supportsVisibleFederation()` are `true`
Method	getBudgetEntryAdminSession
Description	Gets the `OsidSession` associated with the budget entry administration service.
Return	`osid.financials.budgeting.BudgetEntryAdminSession`		a `BudgetEntryAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetEntryAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryAdmin()` is `true.`
Method	getBudgetEntryAdminSessionForBusiness
Description	Gets the `OsidSession` associated with the budget entry administration service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetEntryAdminSession`		a `BudgetEntryAdminSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetEntryAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryAdmin()` and `supportsVisibleFederation()` are `true`
Method	getBudgetEntryNotificationSession
Description	Gets the `OsidSession` associated with the budget entry notification service.
Parameters	`osid.financials.budgeting.BudgetEntryReceiver`	`budgetEntryReceiver`	the notification callback
Return	`osid.financials.budgeting.BudgetEntryNotificationSession`		a `BudgetEntryNotificationSession`
Errors	NULL_ARGUMENT		`budgetEntryReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetEntryNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryNotification()` is `true.`
Method	getBudgetEntryNotificationSessionForBusiness
Description	Gets the `OsidSession` associated with the budget entry notification service for the given business.
Parameters	`osid.financials.budgeting.BudgetEntryReceiver`	`budgetEntryReceiver`	the notification callback
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetEntryNotificationSession`		a `BudgetEntryNotificationSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`budgetEntryReceiver` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetEntryNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryNotification()` and `supportsVisibleFederation()` are `true`
Method	getBudgetEntryBusinessSession
Description	Gets the `OsidSession` to lookup entry/catalog mappings.
Return	`osid.financials.budgeting.BudgetEntryBusinessSession`		a `BudgetEntryBusinessSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetEntryBusiness()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryBusiness()` is `true.`
Method	getBudgetEntryBusinessAssignmentSession
Description	Gets the `OsidSession` associated with assigning budget entries to businesses.
Return	`osid.financials.budgeting.BudgetEntryBusinessAssignmentSession`		a `BudgetEntryBusinessAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBudgetEntryBusinessAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntryBusinessAssignment()` is `true.`
Method	getBudgetEntrySmartBusinessSession
Description	Gets the `OsidSession` associated with the budget entry smart business service.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Return	`osid.financials.budgeting.BudgetEntrySmartBusinessSession`		a `BudgetEntrySmartBusinessSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBudgetEntrySmartBusiness()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBudgetEntrySmartBusiness()` and `supportsVisibleFederation()` are `true`
Method	getFinancialsBudgetingBatchManager
Description	Gets a `FinancialsBudgetingBatchManager.`
Return	`osid.financials.budgeting.batch.FinancialsBudgetingBatchManager`		a `FinancialsBudgetingBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsFinancialsBudgetingBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFinancialsBudgetingBatch()` is `true.`