org.osid.financials

Interface FinancialsProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, FinancialsProfile, OsidProfile, OsidProxyManager, Sourceable

public interface FinancialsProxyManager
extends OsidProxyManager, FinancialsProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
AccountAdminSession	getAccountAdminSession(Proxy proxy) Gets the OsidSession associated with the account administration service.
AccountAdminSession	getAccountAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the account administration service for the given business.
AccountBusinessAssignmentSession	getAccountBusinessAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning accounts to businesses.
AccountBusinessSession	getAccountBusinessSession(Proxy proxy) Gets the OsidSession to lookup account/catalog mappings.
AccountHierarchyDesignSession	getAccountHierarchyDesignSession(Proxy proxy) Gets the session designing account hierarchies.
AccountHierarchyDesignSession	getAccountHierarchyDesignSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the account heirarchy design service for the given business.
AccountHierarchySession	getAccountHierarchySession(Proxy proxy) Gets the session traversing account hierarchies.
AccountHierarchySession	getAccountHierarchySessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the account heirarchy traversal service for the given business.
AccountLookupSession	getAccountLookupSession(Proxy proxy) Gets the OsidSession associated with the account lookup service.
AccountLookupSession	getAccountLookupSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the account lookup service for the given business.
AccountNotificationSession	getAccountNotificationSession(AccountReceiver accountReceiver, Proxy proxy) Gets the OsidSession associated with the account notification service.
AccountNotificationSession	getAccountNotificationSessionForBusiness(AccountReceiver accountReceiver, Id businessId, Proxy proxy) Gets the OsidSession associated with the account notification service for the given business.
AccountQuerySession	getAccountQuerySession(Proxy proxy) Gets the OsidSession associated with the account query service.
AccountQuerySession	getAccountQuerySessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the account query service for the given business.
AccountSearchSession	getAccountSearchSession(Proxy proxy) Gets the OsidSession associated with the account search service.
AccountSearchSession	getAccountSearchSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the account search service for the given business.
AccountSmartBusinessSession	getAccountSmartBusinessSession(Id businessId, Proxy proxy) Gets the OsidSession associated with the account smart business service.
ActivityAdminSession	getActivityAdminSession(Proxy proxy) Gets the OsidSession associated with the activity administration service.
ActivityAdminSession	getActivityAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the activity administration service for the given business.
ActivityBusinessAssignmentSession	getActivityBusinessAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning activities to businesses.
ActivityBusinessSession	getActivityBusinessSession(Proxy proxy) Gets the OsidSession to lookup activity/catalog mappings.
ActivityHierarchyDesignSession	getActivityHierarchyDesignSession(Proxy proxy) Gets the session designing activity hierarchies.
ActivityHierarchyDesignSession	getActivityHierarchyDesignSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the activity heirarchy design service for the given business.
ActivityHierarchySession	getActivityHierarchySession(Proxy proxy) Gets the session traversing activity hierarchies.
ActivityHierarchySession	getActivityHierarchySessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the activity heirarchy traversal service for the given business.
ActivityLookupSession	getActivityLookupSession(Proxy proxy) Gets the OsidSession associated with the activity lookup service.
ActivityLookupSession	getActivityLookupSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the activity lookup service for the given business.
ActivityNotificationSession	getActivityNotificationSession(ActivityReceiver activityReceiver, Proxy proxy) Gets the OsidSession associated with the activity notification service.
ActivityNotificationSession	getActivityNotificationSessionForBusiness(ActivityReceiver activityReceiver, Id businessId, Proxy proxy) Gets the OsidSession associated with the activity notification service for the given business.
ActivityQuerySession	getActivityQuerySession(Proxy proxy) Gets the OsidSession associated with the activity query service.
ActivityQuerySession	getActivityQuerySessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the activity query service for the given business.
ActivitySearchSession	getActivitySearchSession(Proxy proxy) Gets the OsidSession associated with the activity search service.
ActivitySearchSession	getActivitySearchSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the activity search service for the given business.
ActivitySmartBusinessSession	getActivitySmartBusinessSession(Id businessId, Proxy proxy) Gets the OsidSession associated with the activity smart business service.
BusinessAdminSession	getBusinessAdminSession(Proxy proxy) Gets the OsidSession associated with the business administrative service.
BusinessHierarchyDesignSession	getBusinessHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the business hierarchy design service.
BusinessHierarchySession	getBusinessHierarchySession(Proxy proxy) Gets the OsidSession associated with the business hierarchy service.
BusinessLookupSession	getBusinessLookupSession(Proxy proxy) Gets the OsidSession associated with the business lookup service.
BusinessNotificationSession	getBusinessNotificationSession(BusinessReceiver businessReceiver, Proxy proxy) Gets the OsidSession associated with the business notification service.
BusinessQuerySession	getBusinessQuerySession(Proxy proxy) Gets the OsidSession associated with the business query service.
BusinessSearchSession	getBusinessSearchSession(Proxy proxy) Gets the OsidSession associated with the business search service.
FinancialsBatchProxyManager	getFinancialsBatchProxyManager() Gets the FinancialsBatchProxyManager.
FinancialsBudgetingProxyManager	getFinancialsBudgetingProxyManager() Gets the FinancialsBudgetingProxyManager.
FinancialsPostingProxyManager	getFinancialsPostingProxyManager() Gets the FinancialsPostingProxyManager.
FiscalPeriodAdminSession	getFiscalPeriodAdminSession(Proxy proxy) Gets the OsidSession associated with the fiscal period administration service.
FiscalPeriodAdminSession	getFiscalPeriodAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the fiscal period administration service for the given business.
FiscalPeriodBusinessAssignmentSession	getFiscalPeriodBusinessAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning fiscal periods to businesses.
FiscalPeriodBusinessSession	getFiscalPeriodBusinessSession(Proxy proxy) Gets the OsidSession to lookup fiscal period/catalog mappings.
FiscalPeriodLookupSession	getFiscalPeriodLookupSession(Proxy proxy) Gets the OsidSession associated with the fiscal period lookup service.
FiscalPeriodLookupSession	getFiscalPeriodLookupSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the fiscal period lookup service for the given business.
FiscalPeriodNotificationSession	getFiscalPeriodNotificationSession(FiscalPeriodReceiver fiscalPeriodReceiver, Proxy proxy) Gets the OsidSession associated with the fiscal period notification service.
FiscalPeriodNotificationSession	getFiscalPeriodNotificationSessionForBusiness(FiscalPeriodReceiver fiscalPeriodReceiver, Id businessId, Proxy proxy) Gets the OsidSession associated with the fiscal period notification service for the given business.
FiscalPeriodQuerySession	getFiscalPeriodQuerySession(Proxy proxy) Gets the OsidSession associated with the fiscal period query service.
FiscalPeriodQuerySession	getFiscalPeriodQuerySessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the fiscal period query service for the given business.
FiscalPeriodSearchSession	getFiscalPeriodSearchSession(Proxy proxy) Gets the OsidSession associated with the fiscal period search service.
FiscalPeriodSearchSession	getFiscalPeriodSearchSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the fiscal period search service for the given business.
FiscalPeriodSmartBusinessSession	getFiscalPeriodSmartBusinessSession(Id businessId, Proxy proxy) Gets the OsidSession associated with the fiscal period smart business service.
ReportingSession	getReportingSession(Proxy proxy) Gets the OsidSession associated with the reporting service.
ReportingSession	getReportingSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the reporting service for the given business.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.financials.FinancialsProfile

getAccountRecordTypes, getAccountSearchRecordTypes, getActivityRecordTypes, getActivitySearchRecordTypes, getBusinessRecordTypes, getBusinessSearchRecordTypes, getFiscalPeriodRecordTypes, getFiscalPeriodSearchRecordTypes, getSummaryRecordTypes, supportsAccountAdmin, supportsAccountBusiness, supportsAccountBusinessAssignment, supportsAccountHierarchy, supportsAccountHierarchyDesign, supportsAccountLookup, supportsAccountNotification, supportsAccountQuery, supportsAccountRecordType, supportsAccountSearch, supportsAccountSearchRecordType, supportsAccountSmartBusiness, supportsActivityAdmin, supportsActivityBusiness, supportsActivityBusinessAssignment, supportsActivityHierarchy, supportsActivityHierarchyDesign, supportsActivityLookup, supportsActivityNotification, supportsActivityQuery, supportsActivityRecordType, supportsActivitySearch, supportsActivitySearchRecordType, supportsActivitySmartBusiness, supportsBusinessAdmin, supportsBusinessHierarchy, supportsBusinessHierarchyDesign, supportsBusinessLookup, supportsBusinessNotification, supportsBusinessQuery, supportsBusinessRecordType, supportsBusinessSearch, supportsBusinessSearchRecordType, supportsFinancialsBatch, supportsFinancialsBudgeting, supportsFinancialsPosting, supportsFiscalPeriodAdmin, supportsFiscalPeriodBusiness, supportsFiscalPeriodBusinessAssignment, supportsFiscalPeriodLookup, supportsFiscalPeriodNotification, supportsFiscalPeriodQuery, supportsFiscalPeriodRecordType, supportsFiscalPeriodSearch, supportsFiscalPeriodSearchRecordType, supportsFiscalPeriodSmartBusiness, supportsSummaryRecordType, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getReportingSession

ReportingSession getReportingSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the reporting service.

Parameters:

proxy - proxy

Returns:

a ReportingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReporting() is false

Compliance:

optional - This method must be implemented if supportsReporting() is true.

getReportingSessionForBusiness

ReportingSession getReportingSessionForBusiness(Id businessId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - proxy

Returns:

a ReportingSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReporting() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsReporting() and supportsVisibleFederation() are true

getAccountLookupSession

AccountLookupSession getAccountLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the account lookup service.

Parameters:

proxy - proxy

Returns:

an AccountSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountLookup() is false

Compliance:

optional - This method must be implemented if supportsAccountLookup() is true.

getAccountLookupSessionForBusiness

AccountLookupSession getAccountLookupSessionForBusiness(Id businessId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - proxy

Returns:

an AccountLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAccountLookup() and supportsVisibleFederation() are true

getAccountQuerySession

AccountQuerySession getAccountQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the account query service.

Parameters:

proxy - proxy

Returns:

an AccountQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountQuery() is false

Compliance:

optional - This method must be implemented if supportsAccountQuery() is true.

getAccountQuerySessionForBusiness

AccountQuerySession getAccountQuerySessionForBusiness(Id businessId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an AccountQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAccountQuery() and supportsVisibleFederation() are true

getAccountSearchSession

AccountSearchSession getAccountSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the account search service.

Parameters:

proxy - proxy

Returns:

an AccountSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountSearch() is false

Compliance:

optional - This method must be implemented if supportsAccountSearch() is true.

getAccountSearchSessionForBusiness

AccountSearchSession getAccountSearchSessionForBusiness(Id businessId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an AccountSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAccountSearch() and supportsVisibleFederation() are true

getAccountAdminSession

AccountAdminSession getAccountAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the account administration service.

Parameters:

proxy - proxy

Returns:

an AccountAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountAdmin() is false

Compliance:

optional - This method must be implemented if supportsAccountAdmin() is true.

getAccountAdminSessionForBusiness

AccountAdminSession getAccountAdminSessionForBusiness(Id businessId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an AccountAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAccountAdmin() and supportsVisibleFederation() are true

getAccountNotificationSession

AccountNotificationSession getAccountNotificationSession(AccountReceiver accountReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the account notification service.

Parameters:

accountReceiver - the notification callback

proxy - proxy

Returns:

an AccountNotificationSession

Throws:

NullArgumentException - accountReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountNotification() is false

Compliance:

optional - This method must be implemented if supportsAccountNotification() is true.

getAccountNotificationSessionForBusiness

AccountNotificationSession getAccountNotificationSessionForBusiness(AccountReceiver accountReceiver,
                                                                  Id businessId,
                                                                  Proxy proxy)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

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

Parameters:

accountReceiver - the notification callback

businessId - the Id of the Business

proxy - proxy

Returns:

an AccountNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - accountReceiver, businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAccountNotification() and supportsVisibleFederation() are true

getAccountHierarchySession

AccountHierarchySession getAccountHierarchySession(Proxy proxy)
                                                   throws OperationFailedException

Gets the session traversing account hierarchies.

Parameters:

proxy - a proxy

Returns:

an AccountHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountHierarchy() is false

Compliance:

optional - This method must be implemented if supportsAccountHierarchy() is true.

getAccountHierarchySessionForBusiness

AccountHierarchySession getAccountHierarchySessionForBusiness(Id businessId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - a proxy

Returns:

an AccountHierarchySession

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountHierarchy() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAccountHierarchy() and supportsVisibleFederation() are true.

getAccountHierarchyDesignSession

AccountHierarchyDesignSession getAccountHierarchyDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the session designing account hierarchies.

Parameters:

proxy - a proxy

Returns:

an AccountHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsAccountHierarchyDesign() is true.

getAccountHierarchyDesignSessionForBusiness

AccountHierarchyDesignSession getAccountHierarchyDesignSessionForBusiness(Id businessId,
                                                                        Proxy proxy)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - a proxy

Returns:

an AccountHierarchyDesignSession

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAccountHierarchyDesign() and supportsVisibleFederation() are true.

getAccountBusinessSession

AccountBusinessSession getAccountBusinessSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession to lookup account/catalog mappings.

Parameters:

proxy - proxy

Returns:

an AccountCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountCatalog() is false

Compliance:

optional - This method must be implemented if supportsAccountCatalog() is true.

getAccountBusinessAssignmentSession

AccountBusinessAssignmentSession getAccountBusinessAssignmentSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with assigning accounts to businesses.

Parameters:

proxy - proxy

Returns:

an AccountCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountCatalogAssignment() is false

Compliance:

optional - This method must be implemented if supportsAccountCatalogAssignment() is true.

getAccountSmartBusinessSession

AccountSmartBusinessSession getAccountSmartBusinessSession(Id businessId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the account smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an AccountSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountSmartBusiness() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAccountSmartBusiness() and supportsVisibleFederation() are true

getActivityLookupSession

ActivityLookupSession getActivityLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the activity lookup service.

Parameters:

proxy - proxy

Returns:

an ActivityLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityLookup() is false

Compliance:

optional - This method must be implemented if supportsActivityLookup() is true.

getActivityLookupSessionForBusiness

ActivityLookupSession getActivityLookupSessionForBusiness(Id businessId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an ActivityLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivityLookup() and supportsVisibleFederation() are true

getActivityQuerySession

ActivityQuerySession getActivityQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the activity query service.

Parameters:

proxy - proxy

Returns:

an ActivityQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityQuery() is false

Compliance:

optional - This method must be implemented if supportsActivityQuery() is true.

getActivityQuerySessionForBusiness

ActivityQuerySession getActivityQuerySessionForBusiness(Id businessId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an ActivityQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivityQuery() and supportsVisibleFederation() are true

getActivitySearchSession

ActivitySearchSession getActivitySearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the activity search service.

Parameters:

proxy - proxy

Returns:

an ActivitySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySearch() is false

Compliance:

optional - This method must be implemented if supportsActivitySearch() is true.

getActivitySearchSessionForBusiness

ActivitySearchSession getActivitySearchSessionForBusiness(Id businessId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an ActivitySearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivitySearch() and supportsVisibleFederation() are true

getActivityAdminSession

ActivityAdminSession getActivityAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the activity administration service.

Parameters:

proxy - proxy

Returns:

an ActivityAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityAdmin() is false

Compliance:

optional - This method must be implemented if supportsActivityAdmin() is true.

getActivityAdminSessionForBusiness

ActivityAdminSession getActivityAdminSessionForBusiness(Id businessId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an ActivityAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivityAdmin() and supportsVisibleFederation() are true

getActivityNotificationSession

ActivityNotificationSession getActivityNotificationSession(ActivityReceiver activityReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the activity notification service.

Parameters:

activityReceiver - the notification callback

proxy - proxy

Returns:

an ActivityNotificationSession

Throws:

NullArgumentException - activityReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityNotification() is false

Compliance:

optional - This method must be implemented if supportsActivityNotification() is true.

getActivityNotificationSessionForBusiness

ActivityNotificationSession getActivityNotificationSessionForBusiness(ActivityReceiver activityReceiver,
                                                                    Id businessId,
                                                                    Proxy proxy)
                                                                      throws NotFoundException,
                                                                             OperationFailedException

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

Parameters:

activityReceiver - the notification callback

businessId - the Id of the Business

proxy - proxy

Returns:

an ActivityNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - activityReceiver, businessId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivityNotification() and supportsVisibleFederation() are true

getActivityHierarchySession

ActivityHierarchySession getActivityHierarchySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the session traversing activity hierarchies.

Parameters:

proxy - a proxy

Returns:

an ActivityHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityHierarchy() is false

Compliance:

optional - This method must be implemented if supportsActivityHierarchy() is true.

getActivityHierarchySessionForBusiness

ActivityHierarchySession getActivityHierarchySessionForBusiness(Id businessId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - a proxy

Returns:

an ActivityHierarchySession

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityHierarchy() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivityHierarchy() and supportsVisibleFederation() are true.

getActivityHierarchyDesignSession

ActivityHierarchyDesignSession getActivityHierarchyDesignSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the session designing activity hierarchies.

Parameters:

proxy - a proxy

Returns:

an ActivityHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsActivityHierarchyDesign() is true.

getActivityHierarchyDesignSessionForBusiness

ActivityHierarchyDesignSession getActivityHierarchyDesignSessionForBusiness(Id businessId,
                                                                          Proxy proxy)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - a proxy

Returns:

a ActivityHierarchyDesignSession

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivityHierarchyDesign() and supportsVisibleFederation() are true.

getActivityBusinessSession

ActivityBusinessSession getActivityBusinessSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession to lookup activity/catalog mappings.

Parameters:

proxy - proxy

Returns:

an ActivityCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityCatalog() is false

Compliance:

optional - This method must be implemented if supportsActivityCatalog() is true.

getActivityBusinessAssignmentSession

ActivityBusinessAssignmentSession getActivityBusinessAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with assigning activities to businesses.

Parameters:

proxy - proxy

Returns:

an ActivityCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityCatalogAssignment() is false

Compliance:

optional - This method must be implemented if supportsActivityCatalogAssignment() is true.

getActivitySmartBusinessSession

ActivitySmartBusinessSession getActivitySmartBusinessSession(Id businessId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the activity smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an ActivitySmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivitySmartBusiness() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActivitySmartBusiness() and supportsVisibleFederation() are true

getFiscalPeriodLookupSession

FiscalPeriodLookupSession getFiscalPeriodLookupSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the fiscal period lookup service.

Parameters:

proxy - proxy

Returns:

a FiscalPeriodSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodLookup() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodLookup() is true.

getFiscalPeriodLookupSessionForBusiness

FiscalPeriodLookupSession getFiscalPeriodLookupSessionForBusiness(Id businessId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - proxy

Returns:

a FiscalPeriodLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodLookup() and supportsVisibleFederation() are true

getFiscalPeriodQuerySession

FiscalPeriodQuerySession getFiscalPeriodQuerySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the fiscal period query service.

Parameters:

proxy - proxy

Returns:

a FiscalPeriodQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodQuery() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodQuery() is true.

getFiscalPeriodQuerySessionForBusiness

FiscalPeriodQuerySession getFiscalPeriodQuerySessionForBusiness(Id businessId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a FiscalPeriodQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodQuery() and supportsVisibleFederation() are true

getFiscalPeriodSearchSession

FiscalPeriodSearchSession getFiscalPeriodSearchSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the fiscal period search service.

Parameters:

proxy - proxy

Returns:

a FiscalPeriodSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodSearch() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodSearch() is true.

getFiscalPeriodSearchSessionForBusiness

FiscalPeriodSearchSession getFiscalPeriodSearchSessionForBusiness(Id businessId,
                                                                Proxy proxy)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a FiscalPeriodSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodSearch() and supportsVisibleFederation() are true

getFiscalPeriodAdminSession

FiscalPeriodAdminSession getFiscalPeriodAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the fiscal period administration service.

Parameters:

proxy - proxy

Returns:

a FiscalPeriodAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodAdmin() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodAdmin() is true.

getFiscalPeriodAdminSessionForBusiness

FiscalPeriodAdminSession getFiscalPeriodAdminSessionForBusiness(Id businessId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a FiscalPeriodAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodAdmin() and supportsVisibleFederation() are true

getFiscalPeriodNotificationSession

FiscalPeriodNotificationSession getFiscalPeriodNotificationSession(FiscalPeriodReceiver fiscalPeriodReceiver,
                                                                 Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the fiscal period notification service.

Parameters:

fiscalPeriodReceiver - the notification callback

proxy - proxy

Returns:

a FiscalPeriodNotificationSession

Throws:

NullArgumentException - fiscalPeriodReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodNotification() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodNotification() is true.

getFiscalPeriodNotificationSessionForBusiness

FiscalPeriodNotificationSession getFiscalPeriodNotificationSessionForBusiness(FiscalPeriodReceiver fiscalPeriodReceiver,
                                                                            Id businessId,
                                                                            Proxy proxy)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

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

Parameters:

fiscalPeriodReceiver - the notification callback

businessId - the Id of the Business

proxy - proxy

Returns:

a FiscalPeriodNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - fiscalPeriodReceiver, businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodNotification() and supportsVisibleFederation() are true

getFiscalPeriodBusinessSession

FiscalPeriodBusinessSession getFiscalPeriodBusinessSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession to lookup fiscal period/catalog mappings.

Parameters:

proxy - proxy

Returns:

a FiscalPeriodBusinessSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodBusiness() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodBusiness() is true.

getFiscalPeriodBusinessAssignmentSession

FiscalPeriodBusinessAssignmentSession getFiscalPeriodBusinessAssignmentSession(Proxy proxy)
                                                                               throws OperationFailedException

Gets the OsidSession associated with assigning fiscal periods to businesses.

Parameters:

proxy - proxy

Returns:

a FiscalPeriodBusinessAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodBusinessAssignment() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodBusinessAssignment() is true.

getFiscalPeriodSmartBusinessSession

FiscalPeriodSmartBusinessSession getFiscalPeriodSmartBusinessSession(Id businessId,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a FiscalPeriodSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodSmartBusiness() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsFiscalPeriodSmartBusiness() and supportsVisibleFederation() are true

getBusinessLookupSession

BusinessLookupSession getBusinessLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the business lookup service.

Parameters:

proxy - proxy

Returns:

a BusinessLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessLookup() is false

Compliance:

optional - This method must be implemented if supportsBusinessLookup() is true.

getBusinessQuerySession

BusinessQuerySession getBusinessQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the business query service.

Parameters:

proxy - proxy

Returns:

a BusinessQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessQuery() is false

Compliance:

optional - This method must be implemented if supportsBusinessQuery() is true.

getBusinessSearchSession

BusinessSearchSession getBusinessSearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the business search service.

Parameters:

proxy - proxy

Returns:

a BusinessSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessSearch() is false

Compliance:

optional - This method must be implemented if supportsBusinessSearch() is true.

getBusinessAdminSession

BusinessAdminSession getBusinessAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the business administrative service.

Parameters:

proxy - proxy

Returns:

a BusinessAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessAdmin() is false

Compliance:

optional - This method must be implemented if supportsBusinessAdmin() is true.

getBusinessNotificationSession

BusinessNotificationSession getBusinessNotificationSession(BusinessReceiver businessReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the business notification service.

Parameters:

businessReceiver - the notification callback

proxy - proxy

Returns:

a BusinessNotificationSession

Throws:

NullArgumentException - businessReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessNotification() is false

Compliance:

optional - This method must be implemented if supportsBusinessNotification() is true.

getBusinessHierarchySession

BusinessHierarchySession getBusinessHierarchySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the business hierarchy service.

Parameters:

proxy - proxy

Returns:

a BusinessHierarchySession for businesses

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessHierarchy() is false

Compliance:

optional - This method must be implemented if supportsBusinessHierarchy() is true.

getBusinessHierarchyDesignSession

BusinessHierarchyDesignSession getBusinessHierarchyDesignSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the business hierarchy design service.

Parameters:

proxy - proxy

Returns:

a HierarchyDesignSession for businesses

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsBusinessHierarchyDesign() is true.

getFinancialsBatchProxyManager

FinancialsBatchProxyManager getFinancialsBatchProxyManager()
                                                           throws OperationFailedException

Gets the FinancialsBatchProxyManager.

Returns:

a FinancialsBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFinancialsBatch() is false

Compliance:

optional - This method must be implemented if supportsFinancialsBatch() is true.

getFinancialsBudgetingProxyManager

FinancialsBudgetingProxyManager getFinancialsBudgetingProxyManager()
                                                                   throws OperationFailedException

Gets the FinancialsBudgetingProxyManager.

Returns:

a FinancialsBudgetingProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFinancialsBudgeting() is false

Compliance:

optional - This method must be implemented if supportsFinancialsBudgeting() is true.

getFinancialsPostingProxyManager

FinancialsPostingProxyManager getFinancialsPostingProxyManager()
                                                               throws OperationFailedException

Gets the FinancialsPostingProxyManager.

Returns:

a FinancialsPostingProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFinancialsPosting() is false

Compliance:

optional - This method must be implemented if supportsFinancialsPosting() is true.