OSID Logo
OSID Specifications
financials package
Version 3.1.0
Interfaceosid.financials.FinancialsProxyManager
Implementsosid.OsidProxyManager
osid.financials.FinancialsProfile
Description

The financials manager provides access to financials sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy interface for passing information from server environments. The sessions included in this manager are:

  • ReportingSession: a session to retrieve financial statements
  • AccountLookupSession: a session to retrieve accounts
  • AccountQuerySession: a session to query accounts
  • AccountSearchSession: a session to search for accounts
  • AccountAdminSession: a session to create and delete accounts
  • AccountNotificationSession: a session to receive notifications pertaining to account changes
  • AccountHierarchySession: a session to traverse account hierarchies
  • AccountHierarchyDesignSession: a sesion to manage account hierarchies
  • AccountBusinessSession: a session to look up account to business mappings
  • AccountBusinessAssignmentSession: a session to manage account to business mappings
  • AccountSmartBusinessSession: a session to manage dynamic businesses of accounts
  • ActivityLookupSession: a session to retrieve activities
  • ActivityLookupSession: a session to query activities
  • ActivitySearchSession: a session to search for activities
  • ActivityAdminSession: a session to create and delete activities
  • ActivityNotificationSession: a session to receive notifications pertaining to activity changes
  • ActivityHierarchySession: a session to traverse activity hierarchies
  • ActivityHierarchyDesignSession: a sesion to manage activity hierarchies
  • ActivityBusinessSession: a session to look up activity to business mappings
  • ActivityBusinessAssignmentSession: a session to manage activity to business mappings
  • ActivitySmartBusinessAssignmentSession: a session to manage dynamic businesses of activities
  • FiscalPeriodLookupSession: a session to retrieve fiscal periods
  • FiscalPeriodQuerySession: a session to query fiscal periods
  • FiscalPeriodSearchSession: a session to search for fiscal periods
  • FiscalPeriodAdminSession: a session to create and delete fiscal periods
  • FiscalPeriodNotificationSession: a session to receive notifications pertaining to fiscal period changes
  • FiscalPeriodBusinessSession: a session to look up fiscal periods to business mappings
  • FiscalPeriodBusinessSession: a session to look up fiscal period to business mappings
  • FiscalPeriodBusinessAssignmentSession: a session to manage fiscal period to business mappings
  • FiscalPeriodSmartBusinessSession: a session to manage dynamic businesses of fiscal periods
  • BusinessLookupSession: a session to retrieve businesses
  • BusinessQuerySession: a session to query businesses
  • BusinessSearchSession: a session to search for businesses
  • BusinessAdminSession: a session to create and delete businesses
  • BusinessNotificationSession: a session to receive notifications pertaining to business changes
  • BusinessHierarchySession: a session to traverse a hierarchy of businesses
  • BusinessHierarchyDesignSession: a session to manage a business hierarchy
MethodgetReportingSession
Description

Gets the OsidSession associated with the reporting service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.ReportingSession a ReportingSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsReporting() is false
Complianceoptional This method must be implemented if supportsReporting() is true.
MethodgetReportingSessionForBusiness
Description

Gets the OsidSession associated with the reporting service for the given business.

Parametersosid.id.IdbusinessId the Id of the business
osid.proxy.Proxyproxy proxy
Returnosid.financials.ReportingSession a ReportingSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsReporting() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsReporting() and supportsVisibleFederation() are true
MethodgetAccountLookupSession
Description

Gets the OsidSession associated with the account lookup service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.AccountLookupSession an AccountSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountLookup() is false
Complianceoptional This method must be implemented if supportsAccountLookup() is true.
MethodgetAccountLookupSessionForBusiness
Description

Gets the OsidSession associated with the account lookup service for the given business.

Parametersosid.id.IdbusinessId the Id of the business
osid.proxy.Proxyproxy proxy
Returnosid.financials.AccountLookupSession an AccountLookupSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAccountLookup() and supportsVisibleFederation() are true
MethodgetAccountQuerySession
Description

Gets the OsidSession associated with the account query service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.AccountQuerySession an AccountQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountQuery() is false
Complianceoptional This method must be implemented if supportsAccountQuery() is true.
MethodgetAccountQuerySessionForBusiness
Description

Gets the OsidSession associated with the account query service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.AccountQuerySession an AccountQuerySession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAccountQuery() and supportsVisibleFederation() are true
MethodgetAccountSearchSession
Description

Gets the OsidSession associated with the account search service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.AccountSearchSession an AccountSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountSearch() is false
Complianceoptional This method must be implemented if supportsAccountSearch() is true.
MethodgetAccountSearchSessionForBusiness
Description

Gets the OsidSession associated with the account search service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.AccountSearchSession an AccountSearchSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAccountSearch() and supportsVisibleFederation() are true
MethodgetAccountAdminSession
Description

Gets the OsidSession associated with the account administration service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.AccountAdminSession an AccountAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountAdmin() is false
Complianceoptional This method must be implemented if supportsAccountAdmin() is true.
MethodgetAccountAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.AccountAdminSession an AccountAdminSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAccountAdmin() and supportsVisibleFederation() are true
MethodgetAccountNotificationSession
Description

Gets the OsidSession associated with the account notification service.

Parametersosid.financials.AccountReceiveraccountReceiver the notification callback
osid.proxy.Proxyproxy proxy
Returnosid.financials.AccountNotificationSession an AccountNotificationSession
ErrorsNULL_ARGUMENT accountReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountNotification() is false
Complianceoptional This method must be implemented if supportsAccountNotification() is true.
MethodgetAccountNotificationSessionForBusiness
Description

Gets the OsidSession associated with the account notification service for the given business.

Parametersosid.financials.AccountReceiveraccountReceiver the notification callback
osid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.AccountNotificationSession an AccountNotificationSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT accountReceiver, businessId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAccountNotification() and supportsVisibleFederation() are true
MethodgetAccountHierarchySession
Description

Gets the session traversing account hierarchies.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.financials.AccountHierarchySession an AccountHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountHierarchy() is false
Complianceoptional This method must be implemented if supportsAccountHierarchy() is true.
MethodgetAccountHierarchySessionForBusiness
Description

Gets the OsidSession associated with the account heirarchy traversal service for the given business.

Parametersosid.id.IdbusinessId the Id of the business
osid.proxy.Proxyproxy a proxy
Returnosid.financials.AccountHierarchySession an AccountHierarchySession
ErrorsNOT_FOUND businessId not found
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountHierarchy() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAccountHierarchy() and supportsVisibleFederation() are true.
MethodgetAccountHierarchyDesignSession
Description

Gets the session designing account hierarchies.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.financials.AccountHierarchyDesignSession an AccountHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsAccountHierarchyDesign() is true.
MethodgetAccountHierarchyDesignSessionForBusiness
Description

Gets the OsidSession associated with the account heirarchy design service for the given business.

Parametersosid.id.IdbusinessId the Id of the business
osid.proxy.Proxyproxy a proxy
Returnosid.financials.AccountHierarchyDesignSession an AccountHierarchyDesignSession
ErrorsNOT_FOUND businessId not found
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountHierarchyDesign() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAccountHierarchyDesign() and supportsVisibleFederation() are true.
MethodgetAccountBusinessSession
Description

Gets the OsidSession to lookup account/catalog mappings.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.AccountBusinessSession an AccountCatalogSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountCatalog() is false
Complianceoptional This method must be implemented if supportsAccountCatalog() is true.
MethodgetAccountBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning accounts to businesses.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.AccountBusinessAssignmentSession an AccountCatalogAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountCatalogAssignment() is false
Complianceoptional This method must be implemented if supportsAccountCatalogAssignment() is true.
MethodgetAccountSmartBusinessSession
Description

Gets the OsidSession associated with the account smart business service.

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.AccountSmartBusinessSession an AccountSmartBusinessSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAccountSmartBusiness() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAccountSmartBusiness() and supportsVisibleFederation() are true
MethodgetActivityLookupSession
Description

Gets the OsidSession associated with the activity lookup service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.ActivityLookupSession an ActivityLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityLookup() is false
Complianceoptional This method must be implemented if supportsActivityLookup() is true.
MethodgetActivityLookupSessionForBusiness
Description

Gets the OsidSession associated with the activity lookup service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.ActivityLookupSession an ActivityLookupSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActivityLookup() and supportsVisibleFederation() are true
MethodgetActivityQuerySession
Description

Gets the OsidSession associated with the activity query service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.ActivityQuerySession an ActivityQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityQuery() is false
Complianceoptional This method must be implemented if supportsActivityQuery() is true.
MethodgetActivityQuerySessionForBusiness
Description

Gets the OsidSession associated with the activity query service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.ActivityQuerySession an ActivityQuerySession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActivityQuery() and supportsVisibleFederation() are true
MethodgetActivitySearchSession
Description

Gets the OsidSession associated with the activity search service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.ActivitySearchSession an ActivitySearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivitySearch() is false
Complianceoptional This method must be implemented if supportsActivitySearch() is true.
MethodgetActivitySearchSessionForBusiness
Description

Gets the OsidSession associated with the activity search service for the given business.

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.ActivitySearchSession an ActivitySearchSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivitySearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActivitySearch() and supportsVisibleFederation() are true
MethodgetActivityAdminSession
Description

Gets the OsidSession associated with the activity administration service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.ActivityAdminSession an ActivityAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityAdmin() is false
Complianceoptional This method must be implemented if supportsActivityAdmin() is true.
MethodgetActivityAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.ActivityAdminSession an ActivityAdminSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActivityAdmin() and supportsVisibleFederation() are true
MethodgetActivityNotificationSession
Description

Gets the OsidSession associated with the activity notification service.

Parametersosid.financials.ActivityReceiveractivityReceiver the notification callback
osid.proxy.Proxyproxy proxy
Returnosid.financials.ActivityNotificationSession an ActivityNotificationSession
ErrorsNULL_ARGUMENT activityReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityNotification() is false
Complianceoptional This method must be implemented if supportsActivityNotification() is true.
MethodgetActivityNotificationSessionForBusiness
Description

Gets the OsidSession associated with the activity notification service for the given business.

Parametersosid.financials.ActivityReceiveractivityReceiver the notification callback
osid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.ActivityNotificationSession an ActivityNotificationSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT activityReceiver, businessId, or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActivityNotification() and supportsVisibleFederation() are true
MethodgetActivityHierarchySession
Description

Gets the session traversing activity hierarchies.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.financials.ActivityHierarchySession an ActivityHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityHierarchy() is false
Complianceoptional This method must be implemented if supportsActivityHierarchy() is true.
MethodgetActivityHierarchySessionForBusiness
Description

Gets the OsidSession associated with the activity heirarchy traversal service for the given business.

Parametersosid.id.IdbusinessId the Id of the business
osid.proxy.Proxyproxy a proxy
Returnosid.financials.ActivityHierarchySession an ActivityHierarchySession
ErrorsNOT_FOUND businessId not found
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityHierarchy() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActivityHierarchy() and supportsVisibleFederation() are true.
MethodgetActivityHierarchyDesignSession
Description

Gets the session designing activity hierarchies.

Parametersosid.proxy.Proxyproxy a proxy
Returnosid.financials.ActivityHierarchyDesignSession an ActivityHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsActivityHierarchyDesign() is true.
MethodgetActivityHierarchyDesignSessionForBusiness
Description

Gets the OsidSession associated with the activity heirarchy design service for the given business.

Parametersosid.id.IdbusinessId the Id of the business
osid.proxy.Proxyproxy a proxy
Returnosid.financials.ActivityHierarchyDesignSession an ActivityHierarchyDesignSession
ErrorsNOT_FOUND businessId not found
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityHierarchyDesign() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActivityHierarchyDesign() and supportsVisibleFederation() are true.
MethodgetActivityBusinessSession
Description

Gets the OsidSession to lookup activity/catalog mappings.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.ActivityBusinessSession an ActivityCatalogSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityCatalog() is false
Complianceoptional This method must be implemented if supportsActivityCatalog() is true.
MethodgetActivityBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning activities to businesses.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.ActivityBusinessAssignmentSession an ActivityCatalogAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivityCatalogAssignment() is false
Complianceoptional This method must be implemented if supportsActivityCatalogAssignment() is true.
MethodgetActivitySmartBusinessSession
Description

Gets the OsidSession associated with the activity smart business service.

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.ActivitySmartBusinessSession an ActivitySmartBusinessSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsActivitySmartBusiness() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsActivitySmartBusiness() and supportsVisibleFederation() are true
MethodgetFiscalPeriodLookupSession
Description

Gets the OsidSession associated with the fiscal period lookup service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodLookupSession a FiscalPeriodSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodLookup() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodLookup() is true.
MethodgetFiscalPeriodLookupSessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the business
osid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodLookupSession a FiscalPeriodLookupSession
ErrorsNOT_FOUND no Business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodLookup() and supportsVisibleFederation() are true
MethodgetFiscalPeriodQuerySession
Description

Gets the OsidSession associated with the fiscal period query service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodQuerySession a FiscalPeriodQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodQuery() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodQuery() is true.
MethodgetFiscalPeriodQuerySessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodQuerySession a FiscalPeriodQuerySession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodQuery() and supportsVisibleFederation() are true
MethodgetFiscalPeriodSearchSession
Description

Gets the OsidSession associated with the fiscal period search service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodSearchSession a FiscalPeriodSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodSearch() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodSearch() is true.
MethodgetFiscalPeriodSearchSessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodSearchSession a FiscalPeriodSearchSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodSearch() and supportsVisibleFederation() are true
MethodgetFiscalPeriodAdminSession
Description

Gets the OsidSession associated with the fiscal period administration service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodAdminSession a FiscalPeriodAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodAdmin() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodAdmin() is true.
MethodgetFiscalPeriodAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodAdminSession a FiscalPeriodAdminSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodAdmin() and supportsVisibleFederation() are true
MethodgetFiscalPeriodNotificationSession
Description

Gets the OsidSession associated with the fiscal period notification service.

Parametersosid.financials.FiscalPeriodReceiverfiscalPeriodReceiver the notification callback
osid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodNotificationSession a FiscalPeriodNotificationSession
ErrorsNULL_ARGUMENT fiscalPeriodReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodNotification() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodNotification() is true.
MethodgetFiscalPeriodNotificationSessionForBusiness
Description

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

Parametersosid.financials.FiscalPeriodReceiverfiscalPeriodReceiver the notification callback
osid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodNotificationSession a FiscalPeriodNotificationSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT fiscalPeriodReceiver, businessId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodNotification() and supportsVisibleFederation() are true
MethodgetFiscalPeriodBusinessSession
Description

Gets the OsidSession to lookup fiscal period/catalog mappings.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodBusinessSession a FiscalPeriodBusinessSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodBusiness() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodBusiness() is true.
MethodgetFiscalPeriodBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning fiscal periods to businesses.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodBusinessAssignmentSession a FiscalPeriodBusinessAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodBusinessAssignment() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodBusinessAssignment() is true.
MethodgetFiscalPeriodSmartBusinessSession
Description

Gets the OsidSession associated with the fiscal period smart business service.

Parametersosid.id.IdbusinessId the Id of the Business
osid.proxy.Proxyproxy proxy
Returnosid.financials.FiscalPeriodSmartBusinessSession a FiscalPeriodSmartBusinessSession
ErrorsNOT_FOUND no business found by the given Id
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFiscalPeriodSmartBusiness() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsFiscalPeriodSmartBusiness() and supportsVisibleFederation() are true
MethodgetBusinessLookupSession
Description

Gets the OsidSession associated with the business lookup service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.BusinessLookupSession a BusinessLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessLookup() is false
Complianceoptional This method must be implemented if supportsBusinessLookup() is true.
MethodgetBusinessQuerySession
Description

Gets the OsidSession associated with the business query service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.BusinessQuerySession a BusinessQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessQuery() is false
Complianceoptional This method must be implemented if supportsBusinessQuery() is true.
MethodgetBusinessSearchSession
Description

Gets the OsidSession associated with the business search service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.BusinessSearchSession a BusinessSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessSearch() is false
Complianceoptional This method must be implemented if supportsBusinessSearch() is true.
MethodgetBusinessAdminSession
Description

Gets the OsidSession associated with the business administrative service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.BusinessAdminSession a BusinessAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessAdmin() is false
Complianceoptional This method must be implemented if supportsBusinessAdmin() is true.
MethodgetBusinessNotificationSession
Description

Gets the OsidSession associated with the business notification service.

Parametersosid.financials.BusinessReceiverbusinessReceiver the notification callback
osid.proxy.Proxyproxy proxy
Returnosid.financials.BusinessNotificationSession a BusinessNotificationSession
ErrorsNULL_ARGUMENT businessReceiver or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessNotification() is false
Complianceoptional This method must be implemented if supportsBusinessNotification() is true.
MethodgetBusinessHierarchySession
Description

Gets the OsidSession associated with the business hierarchy service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.BusinessHierarchySession a BusinessHierarchySession for businesses
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessHierarchy() is false
Complianceoptional This method must be implemented if supportsBusinessHierarchy() is true.
MethodgetBusinessHierarchyDesignSession
Description

Gets the OsidSession associated with the business hierarchy design service.

Parametersosid.proxy.Proxyproxy proxy
Returnosid.financials.BusinessHierarchyDesignSession a HierarchyDesignSession for businesses
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsBusinessHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsBusinessHierarchyDesign() is true.
MethodgetFinancialsBatchProxyManager
Description

Gets the FinancialsBatchProxyManager.

Returnosid.financials.batch.FinancialsBatchProxyManager a FinancialsBatchProxyManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFinancialsBatch() is false
Complianceoptional This method must be implemented if supportsFinancialsBatch() is true.
MethodgetFinancialsBudgetingProxyManager
Description

Gets the FinancialsBudgetingProxyManager.

Returnosid.financials.budgeting.FinancialsBudgetingProxyManager a FinancialsBudgetingProxyManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFinancialsBudgeting() is false
Complianceoptional This method must be implemented if supportsFinancialsBudgeting() is true.
MethodgetFinancialsPostingProxyManager
Description

Gets the FinancialsPostingProxyManager.

Returnosid.financials.posting.FinancialsPostingProxyManager a FinancialsPostingProxyManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsFinancialsPosting() is false
Complianceoptional This method must be implemented if supportsFinancialsPosting() is true.