org.osid.financials

Interface FinancialsManager

All Superinterfaces:

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

public interface FinancialsManager
extends OsidManager, FinancialsProfile

The financials manager provides access to financials sessions and provides interoperability tests for various aspects of this service. 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() Gets the OsidSession associated with the account administration service.
AccountAdminSession	getAccountAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the account administration service for the given business.
AccountBusinessAssignmentSession	getAccountBusinessAssignmentSession() Gets the OsidSession associated with assigning accounts to businesses.
AccountBusinessSession	getAccountBusinessSession() Gets the OsidSession to lookup account/catalog mappings.
AccountHierarchyDesignSession	getAccountHierarchyDesignSession() Gets the session designing account hierarchies.
AccountHierarchyDesignSession	getAccountHierarchyDesignSessionForBusiness(Id businessId) Gets the OsidSession associated with the account heirarchy design service for the given business.
AccountHierarchySession	getAccountHierarchySession() Gets the session traversing account hierarchies.
AccountHierarchySession	getAccountHierarchySessionForBusiness(Id businessId) Gets the OsidSession associated with the account heirarchy traversal service for the given business.
AccountLookupSession	getAccountLookupSession() Gets the OsidSession associated with the account lookup service.
AccountLookupSession	getAccountLookupSessionForBusiness(Id businessId) Gets the OsidSession associated with the account lookup service for the given business.
AccountNotificationSession	getAccountNotificationSession(AccountReceiver accountReceiver) Gets the OsidSession associated with the account notification service.
AccountNotificationSession	getAccountNotificationSessionForBusiness(AccountReceiver accountReceiver, Id businessId) Gets the OsidSession associated with the account notification service for the given business.
AccountQuerySession	getAccountQuerySession() Gets the OsidSession associated with the account query service.
AccountQuerySession	getAccountQuerySessionForBusiness(Id businessId) Gets the OsidSession associated with the account query service for the given business.
AccountSearchSession	getAccountSearchSession() Gets the OsidSession associated with the account search service.
AccountSearchSession	getAccountSearchSessionForBusiness(Id businessId) Gets the OsidSession associated with the account search service for the given business.
AccountSmartBusinessSession	getAccountSmartBusinessSession(Id businessId) Gets the OsidSession associated with the account smart business service.
ActivityAdminSession	getActivityAdminSession() Gets the OsidSession associated with the activity administration service.
ActivityAdminSession	getActivityAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the activity administration service for the given business.
ActivityBusinessAssignmentSession	getActivityBusinessAssignmentSession() Gets the OsidSession associated with assigning activities to businesses.
ActivityBusinessSession	getActivityBusinessSession() Gets the OsidSession to lookup activity/catalog mappings.
ActivityHierarchyDesignSession	getActivityHierarchyDesignSession() Gets the session designing activity hierarchies.
ActivityHierarchyDesignSession	getActivityHierarchyDesignSessionForBusiness(Id businessId) Gets the OsidSession associated with the activity heirarchy design service for the given business.
ActivityHierarchySession	getActivityHierarchySession() Gets the session traversing activity hierarchies.
ActivityHierarchySession	getActivityHierarchySessionForBusiness(Id businessId) Gets the OsidSession associated with the activity heirarchy traversal service for the given business.
ActivityLookupSession	getActivityLookupSession() Gets the OsidSession associated with the activity lookup service.
ActivityLookupSession	getActivityLookupSessionForBusiness(Id businessId) Gets the OsidSession associated with the activity lookup service for the given business.
ActivityNotificationSession	getActivityNotificationSession(ActivityReceiver activityReceiver) Gets the OsidSession associated with the activity notification service.
ActivityNotificationSession	getActivityNotificationSessionForBusiness(ActivityReceiver activityReceiver, Id businessId) Gets the OsidSession associated with the activity notification service for the given business.
ActivityQuerySession	getActivityQuerySession() Gets the OsidSession associated with the activity query service.
ActivityQuerySession	getActivityQuerySessionForBusiness(Id businessId) Gets the OsidSession associated with the activity query service for the given business.
ActivitySearchSession	getActivitySearchSession() Gets the OsidSession associated with the activity search service.
ActivitySearchSession	getActivitySearchSessionForBusiness(Id businessId) Gets the OsidSession associated with the activity search service for the given business.
ActivitySmartBusinessSession	getActivitySmartBusinessSession(Id businessId) Gets the OsidSession associated with the activity smart business service.
BusinessAdminSession	getBusinessAdminSession() Gets the OsidSession associated with the business administrative service.
BusinessHierarchyDesignSession	getBusinessHierarchyDesignSession() Gets the OsidSession associated with the business hierarchy design service.
BusinessHierarchySession	getBusinessHierarchySession() Gets the OsidSession associated with the business hierarchy service.
BusinessLookupSession	getBusinessLookupSession() Gets the OsidSession associated with the business lookup service.
BusinessNotificationSession	getBusinessNotificationSession(BusinessReceiver businessReceiver) Gets the OsidSession associated with the business notification service.
BusinessQuerySession	getBusinessQuerySession() Gets the OsidSession associated with the business query service.
BusinessSearchSession	getBusinessSearchSession() Gets the OsidSession associated with the business search service.
FinancialsBatchManager	getFinancialsBatchManager() Gets the FinancialsBatchManager.
FinancialsBudgetingManager	getFinancialsBudgetingManager() Gets the FinancialsBudgetingManager.
FinancialsPostingManager	getFinancialsPostingManager() Gets the FinancialsPostingManager.
FiscalPeriodAdminSession	getFiscalPeriodAdminSession() Gets the OsidSession associated with the fiscal period administration service.
FiscalPeriodAdminSession	getFiscalPeriodAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the fiscal period administration service for the given business.
FiscalPeriodBusinessAssignmentSession	getFiscalPeriodBusinessAssignmentSession() Gets the OsidSession associated with assigning fiscal periods to businesses.
FiscalPeriodBusinessSession	getFiscalPeriodBusinessSession() Gets the OsidSession to lookup fiscal period/catalog mappings.
FiscalPeriodLookupSession	getFiscalPeriodLookupSession() Gets the OsidSession associated with the fiscal period lookup service.
FiscalPeriodLookupSession	getFiscalPeriodLookupSessionForBusiness(Id businessId) Gets the OsidSession associated with the fiscal period lookup service for the given business.
FiscalPeriodNotificationSession	getFiscalPeriodNotificationSession(FiscalPeriodReceiver fiscalPeriodReceiver) Gets the OsidSession associated with the fiscal period notification service.
FiscalPeriodNotificationSession	getFiscalPeriodNotificationSessionForBusiness(FiscalPeriodReceiver fiscalPeriodReceiver, Id businessId) Gets the OsidSession associated with the fiscal period notification service for the given business.
FiscalPeriodQuerySession	getFiscalPeriodQuerySession() Gets the OsidSession associated with the fiscal period query service.
FiscalPeriodQuerySession	getFiscalPeriodQuerySessionForBusiness(Id businessId) Gets the OsidSession associated with the fiscal period query service for the given business.
FiscalPeriodSearchSession	getFiscalPeriodSearchSession() Gets the OsidSession associated with the fiscal period search service.
FiscalPeriodSearchSession	getFiscalPeriodSearchSessionForBusiness(Id businessId) Gets the OsidSession associated with the fiscal period search service for the given business.
FiscalPeriodSmartBusinessSession	getFiscalPeriodSmartBusinessSession(Id businessId) Gets the OsidSession associated with the fiscal period smart business service.
ReportingSession	getReportingSession() Gets the OsidSession associated with the reporting service.
ReportingSession	getReportingSessionForBusiness(Id businessId) Gets the OsidSession associated with the reporting service for the given business.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                     throws OperationFailedException

Gets the OsidSession associated with the reporting service.

Returns:

a ReportingSession

Throws:

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)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

businessId - the Id of the business

Returns:

a ReportingSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the account lookup service.

Returns:

an AccountSession

Throws:

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)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the business

Returns:

an AccountLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the account query service.

Returns:

an AccountQuerySession

Throws:

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)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

an AccountQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the account search service.

Returns:

an AccountSearchSession

Throws:

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)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

an AccountSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - 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()
                                           throws OperationFailedException

Gets the OsidSession associated with the account administration service.

Returns:

an AccountAdminSession

Throws:

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)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

an AccountAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - 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)
                                                         throws OperationFailedException

Gets the OsidSession associated with the account notification service.

Parameters:

accountReceiver - the notification callback

Returns:

an AccountNotificationSession

Throws:

NullArgumentException - accountReceiver 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)
                                                                    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

Returns:

an AccountNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - accountReceiver or businessId 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()
                                                   throws OperationFailedException

Gets the session traversing account hierarchies.

Returns:

an AccountHierarchySession

Throws:

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)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

businessId - the Id of the business

Returns:

an AccountHierarchySession

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId 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()
                                                               throws OperationFailedException

Gets the session designing account hierarchies.

Returns:

an AccountHierarchyDesignSession

Throws:

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)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the business

Returns:

an AccountHierarchyDesignSession

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId 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()
                                                 throws OperationFailedException

Gets the OsidSession to lookup account/catalog mappings.

Returns:

an AccountBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountBusiness() is false

Compliance:

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

getAccountBusinessAssignmentSession

AccountBusinessAssignmentSession getAccountBusinessAssignmentSession()
                                                                     throws OperationFailedException

Gets the OsidSession associated with assigning accounts to businesses.

Returns:

an AccountBusinessAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountBusinessAssignment() is false

Compliance:

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

getAccountSmartBusinessSession

AccountSmartBusinessSession getAccountSmartBusinessSession(Id businessId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the account smart business service.

Parameters:

businessId - the Id of the Business

Returns:

an AccountSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the activity lookup service.

Returns:

an ActivityLookupSession

Throws:

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)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

an ActivityLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the activity query service.

Returns:

an ActivityQuerySession

Throws:

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)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

an ActivityQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the activity search service.

Returns:

an ActivitySearchSession

Throws:

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)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

an ActivitySearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the activity administration service.

Returns:

an ActivityAdminSession

Throws:

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)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

an ActivityAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - 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)
                                                           throws OperationFailedException

Gets the OsidSession associated with the activity notification service.

Parameters:

activityReceiver - the notification callback

Returns:

an ActivityNotificationSession

Throws:

NullArgumentException - activityReceiver 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)
                                                                      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

Returns:

an ActivityNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - activityReceiver or businessId 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()
                                                     throws OperationFailedException

Gets the session traversing activity hierarchies.

Returns:

an ActivityHierarchySession

Throws:

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)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the business

Returns:

an ActivityHierarchySession

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId 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()
                                                                 throws OperationFailedException

Gets the session designing activity hierarchies.

Returns:

an ActivityHierarchyDesignSession

Throws:

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)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

businessId - the Id of the business

Returns:

an ActivityHierarchyDesignSession

Throws:

NotFoundException - businessId not found

NullArgumentException - businessId 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()
                                                   throws OperationFailedException

Gets the OsidSession to lookup activity/catalog mappings.

Returns:

an ActivityBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBusiness() is false

Compliance:

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

getActivityBusinessAssignmentSession

ActivityBusinessAssignmentSession getActivityBusinessAssignmentSession()
                                                                       throws OperationFailedException

Gets the OsidSession associated with assigning activities to businesses.

Returns:

an ActivityBusinessAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBusinessAssignment() is false

Compliance:

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

getActivitySmartBusinessSession

ActivitySmartBusinessSession getActivitySmartBusinessSession(Id businessId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the activity smart business service.

Parameters:

businessId - the Id of the Business

Returns:

an ActivitySmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId 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()
                                                       throws OperationFailedException

Gets the OsidSession associated with the fiscal period lookup service.

Returns:

a FiscalPeriodSession

Throws:

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)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

businessId - the Id of the business

Returns:

a FiscalPeriodLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - 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()
                                                     throws OperationFailedException

Gets the OsidSession associated with the fiscal period query service.

Returns:

a FiscalPeriodQuerySession

Throws:

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)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a FiscalPeriodQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - 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()
                                                       throws OperationFailedException

Gets the OsidSession associated with the fiscal period search service.

Returns:

a FiscalPeriodSearchSession

Throws:

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)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a FiscalPeriodSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - 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()
                                                     throws OperationFailedException

Gets the OsidSession associated with the fiscal period administration service.

Returns:

a FiscalPeriodAdminSession

Throws:

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)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a FiscalPeriodAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - 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)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the fiscal period notification service.

Parameters:

fiscalPeriodReceiver - the notification callback

Returns:

a FiscalPeriodNotificationSession

Throws:

NullArgumentException - fiscalPeriodReceiver 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)
                                                                              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

Returns:

a FiscalPeriodNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - fiscalPeriodReceiver or businessId 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()
                                                           throws OperationFailedException

Gets the OsidSession to lookup fiscal period/catalog mappings.

Returns:

a FiscalPeriodBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodBusiness() is false

Compliance:

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

getFiscalPeriodBusinessAssignmentSession

FiscalPeriodBusinessAssignmentSession getFiscalPeriodBusinessAssignmentSession()
                                                                               throws OperationFailedException

Gets the OsidSession associated with assigning fiscal periods to businesses.

Returns:

a FiscalPeriodBusinessAssignmentSession

Throws:

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)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a FiscalPeriodSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the business lookup service.

Returns:

a BusinessLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessLookup() is false

Compliance:

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

getBusinessQuerySession

BusinessQuerySession getBusinessQuerySession()
                                             throws OperationFailedException

Gets the OsidSession associated with the business query service.

Returns:

a BusinessQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessQuery() is false

Compliance:

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

getBusinessSearchSession

BusinessSearchSession getBusinessSearchSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the business search service.

Returns:

a BusinessSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessSearch() is false

Compliance:

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

getBusinessAdminSession

BusinessAdminSession getBusinessAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the business administrative service.

Returns:

a BusinessAdminSession

Throws:

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)
                                                           throws OperationFailedException

Gets the OsidSession associated with the business notification service.

Parameters:

businessReceiver - the notification callback

Returns:

a BusinessNotificationSession

Throws:

NullArgumentException - businessReceiver 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()
                                                     throws OperationFailedException

Gets the OsidSession associated with the business hierarchy service.

Returns:

a BusinessHierarchySession for businesses

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessHierarchy() is false

Compliance:

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

getBusinessHierarchyDesignSession

BusinessHierarchyDesignSession getBusinessHierarchyDesignSession()
                                                                 throws OperationFailedException

Gets the OsidSession associated with the business hierarchy design service.

Returns:

a HierarchyDesignSession for businesses

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessHierarchyDesign() is false

Compliance:

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

getFinancialsBatchManager

FinancialsBatchManager getFinancialsBatchManager()
                                                 throws OperationFailedException

Gets the FinancialsBatchManager.

Returns:

a FinancialsBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFinancialsBatch() is false

Compliance:

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

getFinancialsBudgetingManager

FinancialsBudgetingManager getFinancialsBudgetingManager()
                                                         throws OperationFailedException

Gets the FinancialsBudgetingManager.

Returns:

a FinancialsBudgetingManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFinancialsBudgeting() is false

Compliance:

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

getFinancialsPostingManager

FinancialsPostingManager getFinancialsPostingManager()
                                                     throws OperationFailedException

Gets the FinancialsPostingManager.

Returns:

a FinancialsPostingManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFinancialsPosting() is false

Compliance:

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