OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.FinancialsProfile
Implementsosid.OsidProfile
Description

The financials profile describes the interoperability of financial services.

MethodsupportsVisibleFederation
Description

Tests if visible federation is supported.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountLookup
Description

Tests if looking up accounts is supported.

Returnboolean true if account lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountQuery
Description

Tests if querying accounts is supported.

Returnboolean true if account query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountSearch
Description

Tests if searching accounts is supported.

Returnboolean true if account search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountAdmin
Description

Tests if an account administrative service is supported.

Returnboolean true if account administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountNotification
Description

Tests if an account notification service is supported.

Returnboolean true if account notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountHierarchy
Description

Tests if an account hierarchy traversal is supported.

Returnboolean true if an account hierarchy traversal is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountHierarchyDesign
Description

Tests if account hierarchy design is supported.

Returnboolean true if an account hierarchy design is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountBusiness
Description

Tests if an account cataloging service is supported.

Returnboolean true if account catalog is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountBusinessAssignment
Description

Tests if an account cataloging service is supported. A cataloging service maps accounts to catalogs.

Returnboolean true if account cataloging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountSmartBusiness
Description

Tests if an account smart business session is available.

Returnboolean true if an account smart business session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityLookup
Description

Tests if looking up activities is supported.

Returnboolean true if activity lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityQuery
Description

Tests if querying activities is supported.

Returnboolean true if activity query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActivitySearch
Description

Tests if searching activities is supported.

Returnboolean true if activity search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityAdmin
Description

Tests if activity administrative service is supported.

Returnboolean true if activity administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityNotification
Description

Tests if an activity notification service is supported.

Returnboolean true if activity notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityHierarchy
Description

Tests if an activity hierarchy traversal is supported.

Returnboolean true if an activity hierarchy traversal is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityHierarchyDesign
Description

Tests if activity hierarchy design is supported.

Returnboolean true if an activity hierarchy design is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityBusiness
Description

Tests if an activity cataloging service is supported.

Returnboolean true if activity catalog is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityBusinessAssignment
Description

Tests if an activity cataloging service is supported. A cataloging service maps activities to catalogs.

Returnboolean true if activity cataloging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsActivitySmartBusiness
Description

Tests if an activity smart business session is available.

Returnboolean true if an activity smart business session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodLookup
Description

Tests if looking up fiscal periods is supported.

Returnboolean true if fiscal period lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodQuery
Description

Tests if querying fiscal periods is supported.

Returnboolean true if fiscal period query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodSearch
Description

Tests if searching fiscal periods is supported.

Returnboolean true if fiscal period search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodAdmin
Description

Tests if fiscal period administrative service is supported.

Returnboolean true if fiscal period administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodNotification
Description

Tests if a fiscal period notification service is supported.

Returnboolean true if fiscal period notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodBusiness
Description

Tests if a fiscal period cataloging service is supported.

Returnboolean true if fiscal period catalog is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodBusinessAssignment
Description

Tests if a fiscal period cataloging service is supported. A cataloging service maps fiscal periods to catalogs.

Returnboolean true if fiscal period cataloging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodSmartBusiness
Description

Tests if a fiscal period smart business session is available.

Returnboolean true if a fiscal period smart business session is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessLookup
Description

Tests if looking up businesses is supported.

Returnboolean true if business lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessSearch
Description

Tests if searching businesses is supported.

Returnboolean true if business search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessQuery
Description

Tests if querying businesses is supported.

Returnboolean true if business query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessAdmin
Description

Tests if business administrative service is supported.

Returnboolean true if business administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessNotification
Description

Tests if a business notification service is supported.

Returnboolean true if business notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessHierarchy
Description

Tests for the availability of a business hierarchy traversal service.

Returnboolean true if business hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsBusinessHierarchyDesign
Description

Tests for the availability of a business hierarchy design service.

Returnboolean true if business hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFinancialsBatch
Description

Tests for the availability of a financials batch service.

Returnboolean true if a financials batch service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFinancialsBudgeting
Description

Tests for the availability of a financials budgeting service.

Returnboolean true if a financials budgeting service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsFinancialsPosting
Description

Tests for the availability of a financials postng service.

Returnboolean true if a financials posting service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAccountRecordTypes
Description

Gets the supported Account record types.

Returnosid.type.TypeLista list containing the supported Account record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountRecordType
Description

Tests if the given Account record type is supported.

Parametersosid.type.TypeaccountRecordTypea Type indicating an Account record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT accountRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetAccountSearchRecordTypes
Description

Gets the supported Account search record types.

Returnosid.type.TypeLista list containing the supported Account search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAccountSearchRecordType
Description

Tests if the given Account search record type is supported.

Parametersosid.type.TypeaccountSearchRecordTypea Type indicating an Account search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT accountSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetActivityRecordTypes
Description

Gets the supported Activity record types.

Returnosid.type.TypeLista list containing the supported Activity record types
CompliancemandatoryThis method must be implemented.
MethodsupportsActivityRecordType
Description

Tests if the given Activity record type is supported.

Parametersosid.type.TypeactivityRecordTypea Type indicating an Activity record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT activityRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchRecordTypes
Description

Gets the supported Activity search record types.

Returnosid.type.TypeLista list containing the supported Activity search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsActivitySearchRecordType
Description

Tests if the given Activity search record type is supported.

Parametersosid.type.TypeactivitySearchRecordTypea Type indicating an Activity search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT activitySearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodRecordTypes
Description

Gets the supported FiscalPeriod record types.

Returnosid.type.TypeLista list containing the supported FiscalPeriod record types
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodRecordType
Description

Tests if the given FiscalPeriod record type is supported.

Parametersosid.type.TypefiscalPeriodRecordTypea Type indicating an FiscalPeriod record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT fiscalPeriodRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodSearchRecordTypes
Description

Gets the supported FiscalPeriod search record types.

Returnosid.type.TypeLista list containing the supported FiscalPeriod search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsFiscalPeriodSearchRecordType
Description

Tests if the given FiscalPeriod search record type is supported.

Parametersosid.type.TypefiscalPeriodSearchRecordTypea Type indicating a FiscalPeriod search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT fiscalPeriodSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSummaryRecordTypes
Description

Gets the supported Summary record types.

Returnosid.type.TypeLista list containing the supported Summary record types
CompliancemandatoryThis method must be implemented.
MethodsupportsSummaryRecordType
Description

Tests if the given Summary record type is supported.

Parametersosid.type.TypesummaryRecordTypea Type indicating a Summary record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT summaryRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetBusinessRecordTypes
Description

Gets the supported Business record types.

Returnosid.type.TypeLista list containing the supported Business types
CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessRecordType
Description

Tests if the given Business record type is supported.

Parametersosid.type.TypebusinessRecordTypea Type indicating an Business record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT businessRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetBusinessSearchRecordTypes
Description

Gets the supported Business search record types.

Returnosid.type.TypeLista list containing the supported Business search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsBusinessSearchRecordType
Description

Tests if the given Business search record type is supported.

Parametersosid.type.TypebusinessSearchRecordTypea Type indicating an Business search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT businessSearchRecordType is null
CompliancemandatoryThis method must be implemented.