Interface | osid.financials.FinancialsProxyManager | ||
---|---|---|---|
Implements | osid.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
| ||
Method | getReportingSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.ReportingSession | a ReportingSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsReporting() is false | ||
Compliance | optional | This method must be implemented if supportsReporting() is
true. | |
Method | getReportingSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.ReportingSession | a ReportingSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsReporting() and
supportsVisibleFederation() are true | |
Method | getAccountLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.AccountLookupSession | an AccountSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountLookup() is false | ||
Compliance | optional | This method must be implemented if supportsAccountLookup()
is true. | |
Method | getAccountLookupSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.AccountLookupSession | an AccountLookupSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAccountLookup()
and supportsVisibleFederation() are true | |
Method | getAccountQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.AccountQuerySession | an AccountQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountQuery() is false | ||
Compliance | optional | This method must be implemented if supportsAccountQuery() is
true. | |
Method | getAccountQuerySessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.AccountQuerySession | an AccountQuerySession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAccountQuery()
and supportsVisibleFederation() are true | |
Method | getAccountSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.AccountSearchSession | an AccountSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountSearch() is false | ||
Compliance | optional | This method must be implemented if supportsAccountSearch()
is true. | |
Method | getAccountSearchSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.AccountSearchSession | an AccountSearchSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAccountSearch()
and supportsVisibleFederation() are true | |
Method | getAccountAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.AccountAdminSession | an AccountAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsAccountAdmin() is
true. | |
Method | getAccountAdminSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.AccountAdminSession | an AccountAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAccountAdmin()
and supportsVisibleFederation() are true | |
Method | getAccountNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.financials.AccountReceiver | accountReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.AccountNotificationSession | an AccountNotificationSession | |
Errors | NULL_ARGUMENT | accountReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountNotification() is false | ||
Compliance | optional | This method must be implemented if supportsAccountNotification()
is true. | |
Method | getAccountNotificationSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.financials.AccountReceiver | accountReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.AccountNotificationSession | an AccountNotificationSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAccountNotification()
and supportsVisibleFederation() are true | |
Method | getAccountHierarchySession | ||
Description |
Gets the session traversing account hierarchies. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.financials.AccountHierarchySession | an AccountHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsAccountHierarchy()
is true. | |
Method | getAccountHierarchySessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.financials.AccountHierarchySession | an AccountHierarchySession | |
Errors | NOT_FOUND | businessId not found | |
NULL_ARGUMENT | businessId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountHierarchy() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsAccountHierarchy()
and supportsVisibleFederation() are true.
| |
Method | getAccountHierarchyDesignSession | ||
Description |
Gets the session designing account hierarchies. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.financials.AccountHierarchyDesignSession | an AccountHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsAccountHierarchyDesign()
is true. | |
Method | getAccountHierarchyDesignSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.financials.AccountHierarchyDesignSession | an AccountHierarchyDesignSession | |
Errors | NOT_FOUND | businessId not found | |
NULL_ARGUMENT | businessId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountHierarchyDesign() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsAccountHierarchyDesign()
and supportsVisibleFederation() are true.
| |
Method | getAccountBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.AccountBusinessSession | an AccountCatalogSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsAccountCatalog()
is true. | |
Method | getAccountBusinessAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.AccountBusinessAssignmentSession | an AccountCatalogAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsAccountCatalogAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsAccountCatalogAssignment() is true. | |
Method | getAccountSmartBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.AccountSmartBusinessSession | an AccountSmartBusinessSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsAccountSmartBusiness()
and supportsVisibleFederation() are true | |
Method | getActivityLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.ActivityLookupSession | an ActivityLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityLookup() is false | ||
Compliance | optional | This method must be implemented if supportsActivityLookup()
is true. | |
Method | getActivityLookupSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.ActivityLookupSession | an ActivityLookupSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsActivityLookup()
and supportsVisibleFederation() are true | |
Method | getActivityQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.ActivityQuerySession | an ActivityQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityQuery() is false | ||
Compliance | optional | This method must be implemented if supportsActivityQuery()
is true. | |
Method | getActivityQuerySessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.ActivityQuerySession | an ActivityQuerySession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsActivityQuery()
and supportsVisibleFederation() are true | |
Method | getActivitySearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.ActivitySearchSession | an ActivitySearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivitySearch() is false | ||
Compliance | optional | This method must be implemented if supportsActivitySearch()
is true. | |
Method | getActivitySearchSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.ActivitySearchSession | an ActivitySearchSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsActivitySearch()
and supportsVisibleFederation() are true | |
Method | getActivityAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.ActivityAdminSession | an ActivityAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsActivityAdmin()
is true. | |
Method | getActivityAdminSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.ActivityAdminSession | an ActivityAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsActivityAdmin()
and supportsVisibleFederation() are true | |
Method | getActivityNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.financials.ActivityReceiver | activityReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.ActivityNotificationSession | an ActivityNotificationSession | |
Errors | NULL_ARGUMENT | activityReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityNotification() is false | ||
Compliance | optional | This method must be implemented if supportsActivityNotification()
is true. | |
Method | getActivityNotificationSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.financials.ActivityReceiver | activityReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.ActivityNotificationSession | an ActivityNotificationSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsActivityNotification()
and supportsVisibleFederation() are true | |
Method | getActivityHierarchySession | ||
Description |
Gets the session traversing activity hierarchies. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.financials.ActivityHierarchySession | an ActivityHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsActivityHierarchy()
is true. | |
Method | getActivityHierarchySessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.financials.ActivityHierarchySession | an ActivityHierarchySession | |
Errors | NOT_FOUND | businessId not found | |
NULL_ARGUMENT | businessId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityHierarchy() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityHierarchy()
and supportsVisibleFederation() are true.
| |
Method | getActivityHierarchyDesignSession | ||
Description |
Gets the session designing activity hierarchies. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.financials.ActivityHierarchyDesignSession | an ActivityHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsActivityHierarchyDesign()
is true. | |
Method | getActivityHierarchyDesignSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.financials.ActivityHierarchyDesignSession | a ActivityHierarchyDesignSession | |
Errors | NOT_FOUND | businessId not found | |
NULL_ARGUMENT | businessId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityHierarchyDesign() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityHierarchyDesign()
and supportsVisibleFederation() are true.
| |
Method | getActivityBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.ActivityBusinessSession | an ActivityCatalogSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsActivityCatalog()
is true. | |
Method | getActivityBusinessAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.ActivityBusinessAssignmentSession | an ActivityCatalogAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityCatalogAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityCatalogAssignment() is true. | |
Method | getActivitySmartBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.ActivitySmartBusinessSession | an ActivitySmartBusinessSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsActivitySmartBusiness()
and supportsVisibleFederation() are true | |
Method | getFiscalPeriodLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.FiscalPeriodLookupSession | a FiscalPeriodSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFiscalPeriodLookup() is false | ||
Compliance | optional | This method must be implemented if supportsFiscalPeriodLookup()
is true. | |
Method | getFiscalPeriodLookupSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.FiscalPeriodLookupSession | a FiscalPeriodLookupSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsFiscalPeriodLookup()
and supportsVisibleFederation() are true | |
Method | getFiscalPeriodQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.FiscalPeriodQuerySession | a FiscalPeriodQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFiscalPeriodQuery() is false | ||
Compliance | optional | This method must be implemented if supportsFiscalPeriodQuery()
is true. | |
Method | getFiscalPeriodQuerySessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.FiscalPeriodQuerySession | a FiscalPeriodQuerySession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsFiscalPeriodQuery()
and supportsVisibleFederation() are true | |
Method | getFiscalPeriodSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.FiscalPeriodSearchSession | a FiscalPeriodSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFiscalPeriodSearch() is false | ||
Compliance | optional | This method must be implemented if supportsFiscalPeriodSearch()
is true. | |
Method | getFiscalPeriodSearchSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.FiscalPeriodSearchSession | a FiscalPeriodSearchSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsFiscalPeriodSearch()
and supportsVisibleFederation() are true | |
Method | getFiscalPeriodAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.FiscalPeriodAdminSession | a FiscalPeriodAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFiscalPeriodAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsFiscalPeriodAdmin()
is true. | |
Method | getFiscalPeriodAdminSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.FiscalPeriodAdminSession | a FiscalPeriodAdminSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if supportsFiscalPeriodAdmin()
and supportsVisibleFederation() are true | |
Method | getFiscalPeriodNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.financials.FiscalPeriodReceiver | fiscalPeriodReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.FiscalPeriodNotificationSession | a FiscalPeriodNotificationSession | |
Errors | NULL_ARGUMENT | fiscalPeriodReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFiscalPeriodNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsFiscalPeriodNotification() is true. | |
Method | getFiscalPeriodNotificationSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.financials.FiscalPeriodReceiver | fiscalPeriodReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.FiscalPeriodNotificationSession | a FiscalPeriodNotificationSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if
supportsFiscalPeriodNotification() and
supportsVisibleFederation() are true | |
Method | getFiscalPeriodBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.FiscalPeriodBusinessSession | a FiscalPeriodBusinessSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFiscalPeriodBusiness() is false | ||
Compliance | optional | This method must be implemented if supportsFiscalPeriodBusiness()
is true. | |
Method | getFiscalPeriodBusinessAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.FiscalPeriodBusinessAssignmentSession | a FiscalPeriodBusinessAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFiscalPeriodBusinessAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsFiscalPeriodBusinessAssignment() is true. | |
Method | getFiscalPeriodSmartBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.FiscalPeriodSmartBusinessSession | a FiscalPeriodSmartBusinessSession | |
Errors | NOT_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 | ||
Compliance | optional | This method must be implemented if
supportsFiscalPeriodSmartBusiness() and
supportsVisibleFederation() are true | |
Method | getBusinessLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.BusinessLookupSession | a BusinessLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBusinessLookup() is false | ||
Compliance | optional | This method must be implemented if supportsBusinessLookup()
is true. | |
Method | getBusinessQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.BusinessQuerySession | a BusinessQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBusinessQuery() is false | ||
Compliance | optional | This method must be implemented if supportsBusinessQuery()
is true. | |
Method | getBusinessSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.BusinessSearchSession | a BusinessSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBusinessSearch() is false | ||
Compliance | optional | This method must be implemented if supportsBusinessSearch()
is true. | |
Method | getBusinessAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.BusinessAdminSession | a BusinessAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBusinessAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBusinessAdmin()
is true. | |
Method | getBusinessNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.financials.BusinessReceiver | businessReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.BusinessNotificationSession | a BusinessNotificationSession | |
Errors | NULL_ARGUMENT | businessReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBusinessNotification() is false | ||
Compliance | optional | This method must be implemented if supportsBusinessNotification()
is true. | |
Method | getBusinessHierarchySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.BusinessHierarchySession | a BusinessHierarchySession for businesses | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBusinessHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsBusinessHierarchy()
is true. | |
Method | getBusinessHierarchyDesignSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.BusinessHierarchyDesignSession | a HierarchyDesignSession for businesses | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBusinessHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsBusinessHierarchyDesign()
is true. | |
Method | getFinancialsBatchProxyManager | ||
Description |
Gets the | ||
Return | osid.financials.batch.FinancialsBatchProxyManager | a FinancialsBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFinancialsBatch() is false | ||
Compliance | optional | This method must be implemented if supportsFinancialsBatch()
is true. | |
Method | getFinancialsBudgetingProxyManager | ||
Description |
Gets the | ||
Return | osid.financials.budgeting.FinancialsBudgetingProxyManager | a FinancialsBudgetingProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFinancialsBudgeting() is false | ||
Compliance | optional | This method must be implemented if supportsFinancialsBudgeting()
is true. | |
Method | getFinancialsPostingProxyManager | ||
Description |
Gets the | ||
Return | osid.financials.posting.FinancialsPostingProxyManager | a FinancialsPostingProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFinancialsPosting() is false | ||
Compliance | optional | This method must be implemented if supportsFinancialsPosting()
is true. |