OSID - osid.financials.FinancialsProfile Service Interface Definition

Interface	osid.financials.FinancialsProfile
Implements	`osid.OsidProfile`
Description	The financials profile describes the interoperability of financial services.
Method	supportsVisibleFederation
Description	Tests if visible federation is supported.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountLookup
Description	Tests if looking up accounts is supported.
Return	`boolean`		`true` if account lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountQuery
Description	Tests if querying accounts is supported.
Return	`boolean`		`true` if account query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountSearch
Description	Tests if searching accounts is supported.
Return	`boolean`		`true` if account search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountAdmin
Description	Tests if an account administrative service is supported.
Return	`boolean`		`true` if account administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountNotification
Description	Tests if an account notification service is supported.
Return	`boolean`		`true` if account notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountHierarchy
Description	Tests if an account hierarchy traversal is supported.
Return	`boolean`		`true` if an account hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountHierarchyDesign
Description	Tests if account hierarchy design is supported.
Return	`boolean`		`true` if an account hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountBusiness
Description	Tests if an account cataloging service is supported.
Return	`boolean`		`true` if account catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountBusinessAssignment
Description	Tests if an account cataloging service is supported. A cataloging service maps accounts to catalogs.
Return	`boolean`		`true` if account cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountSmartBusiness
Description	Tests if an account smart business session is available.
Return	`boolean`		`true` if an account smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityLookup
Description	Tests if looking up activities is supported.
Return	`boolean`		`true` if activity lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityQuery
Description	Tests if querying activities is supported.
Return	`boolean`		`true` if activity query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivitySearch
Description	Tests if searching activities is supported.
Return	`boolean`		`true` if activity search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityAdmin
Description	Tests if activity administrative service is supported.
Return	`boolean`		`true` if activity administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityNotification
Description	Tests if an activity notification service is supported.
Return	`boolean`		`true` if activity notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityHierarchy
Description	Tests if an activity hierarchy traversal is supported.
Return	`boolean`		`true` if an activity hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityHierarchyDesign
Description	Tests if activity hierarchy design is supported.
Return	`boolean`		`true` if an activity hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBusiness
Description	Tests if an activity cataloging service is supported.
Return	`boolean`		`true` if activity catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityBusinessAssignment
Description	Tests if an activity cataloging service is supported. A cataloging service maps activities to catalogs.
Return	`boolean`		`true` if activity cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivitySmartBusiness
Description	Tests if an activity smart business session is available.
Return	`boolean`		`true` if an activity smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodLookup
Description	Tests if looking up fiscal periods is supported.
Return	`boolean`		`true` if fiscal period lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodQuery
Description	Tests if querying fiscal periods is supported.
Return	`boolean`		`true` if fiscal period query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodSearch
Description	Tests if searching fiscal periods is supported.
Return	`boolean`		`true` if fiscal period search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodAdmin
Description	Tests if fiscal period administrative service is supported.
Return	`boolean`		`true` if fiscal period administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodNotification
Description	Tests if a fiscal period notification service is supported.
Return	`boolean`		`true` if fiscal period notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodBusiness
Description	Tests if a fiscal period cataloging service is supported.
Return	`boolean`		`true` if fiscal period catalog is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodBusinessAssignment
Description	Tests if a fiscal period cataloging service is supported. A cataloging service maps fiscal periods to catalogs.
Return	`boolean`		`true` if fiscal period cataloging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodSmartBusiness
Description	Tests if a fiscal period smart business session is available.
Return	`boolean`		`true` if a fiscal period smart business session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessLookup
Description	Tests if looking up businesses is supported.
Return	`boolean`		`true` if business lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessSearch
Description	Tests if searching businesses is supported.
Return	`boolean`		`true` if business search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessQuery
Description	Tests if querying businesses is supported.
Return	`boolean`		`true` if business query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessAdmin
Description	Tests if business administrative service is supported.
Return	`boolean`		`true` if business administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessNotification
Description	Tests if a business notification service is supported.
Return	`boolean`		`true` if business notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessHierarchy
Description	Tests for the availability of a business hierarchy traversal service.
Return	`boolean`		`true` if business hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsBusinessHierarchyDesign
Description	Tests for the availability of a business hierarchy design service.
Return	`boolean`		`true` if business hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFinancialsBatch
Description	Tests for the availability of a financials batch service.
Return	`boolean`		`true` if a financials batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFinancialsBudgeting
Description	Tests for the availability of a financials budgeting service.
Return	`boolean`		`true` if a financials budgeting service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFinancialsPosting
Description	Tests for the availability of a financials postng service.
Return	`boolean`		`true` if a financials posting service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAccountRecordTypes
Description	Gets the supported `Account` record types.
Return	`osid.type.TypeList`		a list containing the supported `Account` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountRecordType
Description	Tests if the given `Account` record type is supported.
Parameters	`osid.type.Type`	`accountRecordType`	a `Type` indicating an `Account` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`accountRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAccountSearchRecordTypes
Description	Gets the supported `Account` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Account` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAccountSearchRecordType
Description	Tests if the given `Account` search record type is supported.
Parameters	`osid.type.Type`	`accountSearchRecordType`	a `Type` indicating an `Account` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`accountSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivityRecordTypes
Description	Gets the supported `Activity` record types.
Return	`osid.type.TypeList`		a list containing the supported `Activity` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityRecordType
Description	Tests if the given `Activity` record type is supported.
Parameters	`osid.type.Type`	`activityRecordType`	a `Type` indicating an `Activity` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activityRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getActivitySearchRecordTypes
Description	Gets the supported `Activity` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Activity` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivitySearchRecordType
Description	Tests if the given `Activity` search record type is supported.
Parameters	`osid.type.Type`	`activitySearchRecordType`	a `Type` indicating an `Activity` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`activitySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodRecordTypes
Description	Gets the supported `FiscalPeriod` record types.
Return	`osid.type.TypeList`		a list containing the supported `FiscalPeriod` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodRecordType
Description	Tests if the given `FiscalPeriod` record type is supported.
Parameters	`osid.type.Type`	`fiscalPeriodRecordType`	a `Type` indicating an `FiscalPeriod` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`fiscalPeriodRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFiscalPeriodSearchRecordTypes
Description	Gets the supported `FiscalPeriod` search record types.
Return	`osid.type.TypeList`		a list containing the supported `FiscalPeriod` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFiscalPeriodSearchRecordType
Description	Tests if the given `FiscalPeriod` search record type is supported.
Parameters	`osid.type.Type`	`fiscalPeriodSearchRecordType`	a `Type` indicating a `FiscalPeriod` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`fiscalPeriodSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSummaryRecordTypes
Description	Gets the supported `Summary` record types.
Return	`osid.type.TypeList`		a list containing the supported `Summary` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSummaryRecordType
Description	Tests if the given `Summary` record type is supported.
Parameters	`osid.type.Type`	`summaryRecordType`	a `Type` indicating a `Summary` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`summaryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessRecordTypes
Description	Gets the supported `Business` record types.
Return	`osid.type.TypeList`		a list containing the supported `Business` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessRecordType
Description	Tests if the given `Business` record type is supported.
Parameters	`osid.type.Type`	`businessRecordType`	a `Type` indicating an `Business` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`businessRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessSearchRecordTypes
Description	Gets the supported `Business` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Business` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessSearchRecordType
Description	Tests if the given `Business` search record type is supported.
Parameters	`osid.type.Type`	`businessSearchRecordType`	a `Type` indicating an `Business` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`businessSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.