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

Interface	osid.financials.budgeting.FinancialsBudgetingProfile
Implements	`osid.OsidProfile`
Description	The financials profile describes the interoperability among financials management services.
Method	supportsVisibleFederation
Description	Tests if any business federation is exposed. Federation is exposed when a specific business may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of catalogs appears as a single catalog.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetLookup
Description	Tests if looking up budgets is supported.
Return	`boolean`		`true` if budget lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetQuery
Description	Tests if querying budgets is supported.
Return	`boolean`		`true` if budget query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetSearch
Description	Tests if searching budgets is supported.
Return	`boolean`		`true` if budget search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetAdmin
Description	Tests if budget administrative service is supported.
Return	`boolean`		`true` if budget administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetNotification
Description	Tests if a budget notification service is supported.
Return	`boolean`		`true` if budget notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetBusiness
Description	Tests if a budget cataloging service is supported.
Return	`boolean`		`true` if budget catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetBusinessAssignment
Description	Tests if a budget cataloging service is supported. A cataloging service maps budgets to catalogs.
Return	`boolean`		`true` if budget cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetSmartBusiness
Description	Tests if a budget smart business session is available.
Return	`boolean`		`true` if a budget smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntryLookup
Description	Tests if looking up budget entries is supported.
Return	`boolean`		`true` if budget entry lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntryQuery
Description	Tests if querying budget entries is supported.
Return	`boolean`		`true` if budget entry query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntrySearch
Description	Tests if searching budget entries is supported.
Return	`boolean`		`true` if budget entry search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntryAdmin
Description	Tests if budget entry administrative service is supported.
Return	`boolean`		`true` if budget entry administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntryNotification
Description	Tests if an entry notification service is supported.
Return	`boolean`		`true` if budget entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntryBusiness
Description	Tests if a budget entry cataloging service is supported.
Return	`boolean`		`true` if budget entry catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntryBusinessAssignment
Description	Tests if a budget entry cataloging service is supported.
Return	`boolean`		`true` if budget entry cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntrySmartBusiness
Description	Tests if a budget entry smart business session is available.
Return	`boolean`		`true` if a budget entry smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFinancialsBudgetingBatch
Description	Tests for the availability of a financials budgeting batch service.
Return	`boolean`		`true` if a financials budgeting batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetRecordTypes
Description	Gets the supported `Budget` record types.
Return	`osid.type.TypeList`		a list containing the supported `Budget` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetRecordType
Description	Tests if the given `Budget` record type is supported.
Parameters	`osid.type.Type`	`budgetRecordType`	a `Type` indicating a `Budget` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`budgetRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetSearchRecordTypes
Description	Gets the supported `Budget` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Budget` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetSearchRecordType
Description	Tests if the given `Budget` search record type is supported.
Parameters	`osid.type.Type`	`budgetSearchRecordType`	a `Type` indicating a `Budget` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`budgetSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntryRecordTypes
Description	Gets the supported `BudgetEntry` record types.
Return	`osid.type.TypeList`		a list containing the supported `BudgetEntry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntryRecordType
Description	Tests if the given `BudgetEntry` record type is supported.
Parameters	`osid.type.Type`	`budgetEntryRecordType`	a `Type` indicating a `BudgetEntry` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`budgetEntryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBudgetEntrySearchRecordTypes
Description	Gets the supported `BudgetEntry` search record types.
Return	`osid.type.TypeList`		a list containing the supported `BudgetEntry` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBudgetEntrySearchRecordType
Description	Tests if the given `BudgetEntry` search record type is supported.
Parameters	`osid.type.Type`	`budgetEntrySearchRecordType`	a `Type` indicating a `BudgetEntry` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`budgetEntrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.