Interface FinancialsManager
- All Superinterfaces:
AutoCloseable, Closeable, FinancialsProfile, OsidManager, OsidManager, OsidProfile, Sourceable
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
Modifier and TypeMethodDescriptionGets theOsidSessionassociated with the account administration service.getAccountAdminSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the account administration service for the given business.Gets theOsidSessionassociated with assigning accounts to businesses.Gets theOsidSessionto lookup account/catalog mappings.Gets the session designing account hierarchies.getAccountHierarchyDesignSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the account heirarchy design service for the given business.Gets the session traversing account hierarchies.getAccountHierarchySessionForBusiness(Id businessId) Gets theOsidSessionassociated with the account heirarchy traversal service for the given business.Gets theOsidSessionassociated with the account lookup service.getAccountLookupSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the account lookup service for the given business.getAccountNotificationSession(AccountReceiver accountReceiver) Gets theOsidSessionassociated with the account notification service.getAccountNotificationSessionForBusiness(AccountReceiver accountReceiver, Id businessId) Gets theOsidSessionassociated with the account notification service for the given business.Gets theOsidSessionassociated with the account query service.getAccountQuerySessionForBusiness(Id businessId) Gets theOsidSessionassociated with the account query service for the given business.Gets theOsidSessionassociated with the account search service.getAccountSearchSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the account search service for the given business.getAccountSmartBusinessSession(Id businessId) Gets theOsidSessionassociated with the account smart business service.Gets theOsidSessionassociated with the activity administration service.getActivityAdminSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the activity administration service for the given business.Gets theOsidSessionassociated with assigning activities to businesses.Gets theOsidSessionto lookup activity/catalog mappings.Gets the session designing activity hierarchies.getActivityHierarchyDesignSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the activity heirarchy design service for the given business.Gets the session traversing activity hierarchies.getActivityHierarchySessionForBusiness(Id businessId) Gets theOsidSessionassociated with the activity heirarchy traversal service for the given business.Gets theOsidSessionassociated with the activity lookup service.getActivityLookupSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the activity lookup service for the given business.getActivityNotificationSession(ActivityReceiver activityReceiver) Gets theOsidSessionassociated with the activity notification service.getActivityNotificationSessionForBusiness(ActivityReceiver activityReceiver, Id businessId) Gets theOsidSessionassociated with the activity notification service for the given business.Gets theOsidSessionassociated with the activity query service.getActivityQuerySessionForBusiness(Id businessId) Gets theOsidSessionassociated with the activity query service for the given business.Gets theOsidSessionassociated with the activity search service.getActivitySearchSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the activity search service for the given business.getActivitySmartBusinessSession(Id businessId) Gets theOsidSessionassociated with the activity smart business service.Gets theOsidSessionassociated with the business administrative service.Gets theOsidSessionassociated with the business hierarchy design service.Gets theOsidSessionassociated with the business hierarchy service.Gets theOsidSessionassociated with the business lookup service.getBusinessNotificationSession(BusinessReceiver businessReceiver) Gets theOsidSessionassociated with the business notification service.Gets theOsidSessionassociated with the business query service.Gets theOsidSessionassociated with the business search service.Gets theFinancialsBatchManager.Gets theFinancialsBudgetingManager.Gets theFinancialsPostingManager.Gets theOsidSessionassociated with the fiscal period administration service.getFiscalPeriodAdminSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the fiscal period administration service for the given business.Gets theOsidSessionassociated with assigning fiscal periods to businesses.Gets theOsidSessionto lookup fiscal period/catalog mappings.Gets theOsidSessionassociated with the fiscal period lookup service.getFiscalPeriodLookupSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the fiscal period lookup service for the given business.getFiscalPeriodNotificationSession(FiscalPeriodReceiver fiscalPeriodReceiver) Gets theOsidSessionassociated with the fiscal period notification service.getFiscalPeriodNotificationSessionForBusiness(FiscalPeriodReceiver fiscalPeriodReceiver, Id businessId) Gets theOsidSessionassociated with the fiscal period notification service for the given business.Gets theOsidSessionassociated with the fiscal period query service.getFiscalPeriodQuerySessionForBusiness(Id businessId) Gets theOsidSessionassociated with the fiscal period query service for the given business.Gets theOsidSessionassociated with the fiscal period search service.getFiscalPeriodSearchSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the fiscal period search service for the given business.getFiscalPeriodSmartBusinessSession(Id businessId) Gets theOsidSessionassociated with the fiscal period smart business service.Gets theOsidSessionassociated with the reporting service.getReportingSessionForBusiness(Id businessId) Gets theOsidSessionassociated with the reporting service for the given business.Methods inherited from interface 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, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedAccountrecord types.Gets the supportedAccountsearch record types.Gets the supportedActivityrecord types.Gets the supportedActivitysearch record types.Gets the supportedBusinessrecord types.Gets the supportedBusinesssearch record types.Gets the supportedFiscalPeriodrecord types.Gets the supportedFiscalPeriodsearch record types.Gets the supportedSummaryrecord types.booleanTests if an account administrative service is supported.booleanTests if an account cataloging service is supported.booleanTests if an account cataloging service is supported.booleanTests if an account hierarchy traversal is supported.booleanTests if account hierarchy design is supported.booleanTests if looking up accounts is supported.booleanTests if an account notification service is supported.booleanTests if querying accounts is supported.booleansupportsAccountRecordType(Type accountRecordType) Tests if the givenAccountrecord type is supported.booleanTests if searching accounts is supported.booleansupportsAccountSearchRecordType(Type accountSearchRecordType) Tests if the givenAccountsearch record type is supported.booleanTests if an account smart business session is available.booleanTests if activity administrative service is supported.booleanTests if an activity cataloging service is supported.booleanTests if an activity cataloging service is supported.booleanTests if an activity hierarchy traversal is supported.booleanTests if activity hierarchy design is supported.booleanTests if looking up activities is supported.booleanTests if an activity notification service is supported.booleanTests if querying activities is supported.booleansupportsActivityRecordType(Type activityRecordType) Tests if the givenActivityrecord type is supported.booleanTests if searching activities is supported.booleansupportsActivitySearchRecordType(Type activitySearchRecordType) Tests if the givenActivitysearch record type is supported.booleanTests if an activity smart business session is available.booleanTests if business administrative service is supported.booleanTests for the availability of a business hierarchy traversal service.booleanTests for the availability of a business hierarchy design service.booleanTests if looking up businesses is supported.booleanTests if a business notification service is supported.booleanTests if querying businesses is supported.booleansupportsBusinessRecordType(Type businessRecordType) Tests if the givenBusinessrecord type is supported.booleanTests if searching businesses is supported.booleansupportsBusinessSearchRecordType(Type businessSearchRecordType) Tests if the givenBusinesssearch record type is supported.booleanTests for the availability of a financials batch service.booleanTests for the availability of a financials budgeting service.booleanTests for the availability of a financials postng service.booleanTests if fiscal period administrative service is supported.booleanTests if a fiscal period cataloging service is supported.booleanTests if a fiscal period cataloging service is supported.booleanTests if looking up fiscal periods is supported.booleanTests if a fiscal period notification service is supported.booleanTests if querying fiscal periods is supported.booleansupportsFiscalPeriodRecordType(Type fiscalPeriodRecordType) Tests if the givenFiscalPeriodrecord type is supported.booleanTests if searching fiscal periods is supported.booleansupportsFiscalPeriodSearchRecordType(Type fiscalPeriodSearchRecordType) Tests if the givenFiscalPeriodsearch record type is supported.booleanTests if a fiscal period smart business session is available.booleansupportsSummaryRecordType(Type summaryRecordType) Tests if the givenSummaryrecord type is supported.booleanTests if visible federation is supported.Methods inherited from interface OsidManager
closeMethods inherited from interface OsidManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime) Rolls back this service to a point in time.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getReportingSession
Gets theOsidSessionassociated with the reporting service.- Returns:
- a
ReportingSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsReporting()isfalse- Compliance:
optional- This method must be implemented if {@code supportsReporting()} is {@code true} .
-
getReportingSessionForBusiness
ReportingSession getReportingSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the reporting service for the given business.- Parameters:
businessId- theIdof the business- Returns:
- a
ReportingSession - Throws:
NotFoundException- noBusinessfound by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsReporting()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsReporting()} and {@code supportsVisibleFederation()} are {@code true}
-
getAccountLookupSession
Gets theOsidSessionassociated with the account lookup service.- Returns:
- an
AccountSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAccountLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountLookup()} is {@code true} .
-
getAccountLookupSessionForBusiness
AccountLookupSession getAccountLookupSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the account lookup service for the given business.- Parameters:
businessId- theIdof the business- Returns:
- an
AccountLookupSession - Throws:
NotFoundException- noBusinessfound by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAccountLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getAccountQuerySession
Gets theOsidSessionassociated with the account query service.- Returns:
- an
AccountQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAccountQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountQuery()} is {@code true} .
-
getAccountQuerySessionForBusiness
AccountQuerySession getAccountQuerySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the account query service for the given business.- Parameters:
businessId- theIdof theBusiness- Returns:
- an
AccountQuerySession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAccountQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getAccountSearchSession
Gets theOsidSessionassociated with the account search service.- Returns:
- an
AccountSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAccountSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountSearch()} is {@code true} .
-
getAccountSearchSessionForBusiness
AccountSearchSession getAccountSearchSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the account search service for the given business.- Parameters:
businessId- theIdof theBusiness- Returns:
- an
AccountSearchSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAccountSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getAccountAdminSession
Gets theOsidSessionassociated with the account administration service.- Returns:
- an
AccountAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAccountAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountAdmin()} is {@code true} .
-
getAccountAdminSessionForBusiness
AccountAdminSession getAccountAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the account administration service for the given business.- Parameters:
businessId- theIdof theBusiness- Returns:
- an
AccountAdminSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAccountAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getAccountNotificationSession
AccountNotificationSession getAccountNotificationSession(AccountReceiver accountReceiver) throws OperationFailedException Gets theOsidSessionassociated with the account notification service.- Parameters:
accountReceiver- the notification callback- Returns:
- an
AccountNotificationSession - Throws:
NullArgumentException-accountReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAccountNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountNotification()} is {@code true} .
-
getAccountNotificationSessionForBusiness
AccountNotificationSession getAccountNotificationSessionForBusiness(AccountReceiver accountReceiver, Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the account notification service for the given business.- Parameters:
accountReceiver- the notification callbackbusinessId- theIdof theBusiness- Returns:
- an
AccountNotificationSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-accountReceiverorbusinessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAccountNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getAccountHierarchySession
Gets the session traversing account hierarchies.- Returns:
- an
AccountHierarchySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAccountHierarchy() is false- Compliance:
optional- This method must be implemented if {@code supportsAccountHierarchy()} is true.
-
getAccountHierarchySessionForBusiness
AccountHierarchySession getAccountHierarchySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the account heirarchy traversal service for the given business.- Parameters:
businessId- theIdof the business- Returns:
- an
AccountHierarchySession - Throws:
NotFoundException-businessIdnot foundNullArgumentException-businessIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsAccountHierarchy()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountHierarchy()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAccountHierarchyDesignSession
Gets the session designing account hierarchies.- Returns:
- an
AccountHierarchyDesignSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAccountHierarchyDesign() is false- Compliance:
optional- This method must be implemented if {@code supportsAccountHierarchyDesign()} is true.
-
getAccountHierarchyDesignSessionForBusiness
AccountHierarchyDesignSession getAccountHierarchyDesignSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the account heirarchy design service for the given business.- Parameters:
businessId- theIdof the business- Returns:
- an
AccountHierarchyDesignSession - Throws:
NotFoundException-businessIdnot foundNullArgumentException-businessIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsAccountHierarchyDesign()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code true} .
-
getAccountBusinessSession
Gets theOsidSessionto lookup account/catalog mappings.- Returns:
- an
AccountBusinessSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAccountBusiness()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountBusiness()} is {@code true} .
-
getAccountBusinessAssignmentSession
AccountBusinessAssignmentSession getAccountBusinessAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning accounts to businesses.- Returns:
- an
AccountBusinessAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAccountBusinessAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountBusinessAssignment()} is {@code true} .
-
getAccountSmartBusinessSession
AccountSmartBusinessSession getAccountSmartBusinessSession(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the account smart business service.- Parameters:
businessId- theIdof theBusiness- Returns:
- an
AccountSmartBusinessSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAccountSmartBusiness()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAccountSmartBusiness()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityLookupSession
Gets theOsidSessionassociated with the activity lookup service.- Returns:
- an
ActivityLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityLookup()} is {@code true} .
-
getActivityLookupSessionForBusiness
ActivityLookupSession getActivityLookupSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity lookup service for the given business.- Parameters:
businessId- theIdof theBusiness- Returns:
- an
ActivityLookupSession - Throws:
NotFoundException- noBusinessfound by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityQuerySession
Gets theOsidSessionassociated with the activity query service.- Returns:
- an
ActivityQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityQuery()} is {@code true} .
-
getActivityQuerySessionForBusiness
ActivityQuerySession getActivityQuerySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity query service for the given business.- Parameters:
businessId- theIdof theBusiness- Returns:
- an
ActivityQuerySession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivitySearchSession
Gets theOsidSessionassociated with the activity search service.- Returns:
- an
ActivitySearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivitySearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivitySearch()} is {@code true} .
-
getActivitySearchSessionForBusiness
ActivitySearchSession getActivitySearchSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity search service for the given business.- Parameters:
businessId- theIdof theBusiness- Returns:
- an
ActivitySearchSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivitySearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivitySearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityAdminSession
Gets theOsidSessionassociated with the activity administration service.- Returns:
- an
ActivityAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityAdmin()} is {@code true} .
-
getActivityAdminSessionForBusiness
ActivityAdminSession getActivityAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity administration service for the given business.- Parameters:
businessId- theIdof theBusiness- Returns:
- an
ActivityAdminSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityNotificationSession
ActivityNotificationSession getActivityNotificationSession(ActivityReceiver activityReceiver) throws OperationFailedException Gets theOsidSessionassociated with the activity notification service.- Parameters:
activityReceiver- the notification callback- Returns:
- an
ActivityNotificationSession - Throws:
NullArgumentException-activityReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityNotification()} is {@code true} .
-
getActivityNotificationSessionForBusiness
ActivityNotificationSession getActivityNotificationSessionForBusiness(ActivityReceiver activityReceiver, Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity notification service for the given business.- Parameters:
activityReceiver- the notification callbackbusinessId- theIdof theBusiness- Returns:
- an
ActivityNotificationSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-activityReceiverorbusinessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivityNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getActivityHierarchySession
Gets the session traversing activity hierarchies.- Returns:
- an
ActivityHierarchySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityHierarchy() is false- Compliance:
optional- This method must be implemented if {@code supportsActivityHierarchy()} is true.
-
getActivityHierarchySessionForBusiness
ActivityHierarchySession getActivityHierarchySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity heirarchy traversal service for the given business.- Parameters:
businessId- theIdof the business- Returns:
- an
ActivityHierarchySession - Throws:
NotFoundException-businessIdnot foundNullArgumentException-businessIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsActivityHierarchy()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityHierarchy()} and {@code supportsVisibleFederation()} are {@code true} .
-
getActivityHierarchyDesignSession
Gets the session designing activity hierarchies.- Returns:
- an
ActivityHierarchyDesignSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityHierarchyDesign() is false- Compliance:
optional- This method must be implemented if {@code supportsActivityHierarchyDesign()} is true.
-
getActivityHierarchyDesignSessionForBusiness
ActivityHierarchyDesignSession getActivityHierarchyDesignSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity heirarchy design service for the given business.- Parameters:
businessId- theIdof the business- Returns:
- an
ActivityHierarchyDesignSession - Throws:
NotFoundException-businessIdnot foundNullArgumentException-businessIdisnullOperationFailedException-unable to complete requestUnimplementedException-supportsActivityHierarchyDesign()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code true} .
-
getActivityBusinessSession
Gets theOsidSessionto lookup activity/catalog mappings.- Returns:
- an
ActivityBusinessSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityBusiness()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityBusiness()} is {@code true} .
-
getActivityBusinessAssignmentSession
ActivityBusinessAssignmentSession getActivityBusinessAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning activities to businesses.- Returns:
- an
ActivityBusinessAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsActivityBusinessAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivityBusinessAssignment()} is {@code true} .
-
getActivitySmartBusinessSession
ActivitySmartBusinessSession getActivitySmartBusinessSession(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the activity smart business service.- Parameters:
businessId- theIdof theBusiness- Returns:
- an
ActivitySmartBusinessSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsActivitySmartBusiness()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsActivitySmartBusiness()} and {@code supportsVisibleFederation()} are {@code true}
-
getFiscalPeriodLookupSession
Gets theOsidSessionassociated with the fiscal period lookup service.- Returns:
- a
FiscalPeriodSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodLookup()} is {@code true} .
-
getFiscalPeriodLookupSessionForBusiness
FiscalPeriodLookupSession getFiscalPeriodLookupSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the fiscal period lookup service for the given business.- Parameters:
businessId- theIdof the business- Returns:
- a
FiscalPeriodLookupSession - Throws:
NotFoundException- noBusinessfound by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getFiscalPeriodQuerySession
Gets theOsidSessionassociated with the fiscal period query service.- Returns:
- a
FiscalPeriodQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodQuery()} is {@code true} .
-
getFiscalPeriodQuerySessionForBusiness
FiscalPeriodQuerySession getFiscalPeriodQuerySessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the fiscal period query service for the given business.- Parameters:
businessId- theIdof theBusiness- Returns:
- a
FiscalPeriodQuerySession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getFiscalPeriodSearchSession
Gets theOsidSessionassociated with the fiscal period search service.- Returns:
- a
FiscalPeriodSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodSearch()} is {@code true} .
-
getFiscalPeriodSearchSessionForBusiness
FiscalPeriodSearchSession getFiscalPeriodSearchSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the fiscal period search service for the given business.- Parameters:
businessId- theIdof theBusiness- Returns:
- a
FiscalPeriodSearchSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getFiscalPeriodAdminSession
Gets theOsidSessionassociated with the fiscal period administration service.- Returns:
- a
FiscalPeriodAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodAdmin()} is {@code true} .
-
getFiscalPeriodAdminSessionForBusiness
FiscalPeriodAdminSession getFiscalPeriodAdminSessionForBusiness(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the fiscal period administration service for the given business.- Parameters:
businessId- theIdof theBusiness- Returns:
- a
FiscalPeriodAdminSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getFiscalPeriodNotificationSession
FiscalPeriodNotificationSession getFiscalPeriodNotificationSession(FiscalPeriodReceiver fiscalPeriodReceiver) throws OperationFailedException Gets theOsidSessionassociated with the fiscal period notification service.- Parameters:
fiscalPeriodReceiver- the notification callback- Returns:
- a
FiscalPeriodNotificationSession - Throws:
NullArgumentException-fiscalPeriodReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodNotification()} is {@code true} .
-
getFiscalPeriodNotificationSessionForBusiness
FiscalPeriodNotificationSession getFiscalPeriodNotificationSessionForBusiness(FiscalPeriodReceiver fiscalPeriodReceiver, Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the fiscal period notification service for the given business.- Parameters:
fiscalPeriodReceiver- the notification callbackbusinessId- theIdof theBusiness- Returns:
- a
FiscalPeriodNotificationSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-fiscalPeriodReceiverorbusinessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getFiscalPeriodBusinessSession
Gets theOsidSessionto lookup fiscal period/catalog mappings.- Returns:
- a
FiscalPeriodBusinessSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodBusiness()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodBusiness()} is {@code true} .
-
getFiscalPeriodBusinessAssignmentSession
FiscalPeriodBusinessAssignmentSession getFiscalPeriodBusinessAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning fiscal periods to businesses.- Returns:
- a
FiscalPeriodBusinessAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodBusinessAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodBusinessAssignment()} is {@code true} .
-
getFiscalPeriodSmartBusinessSession
FiscalPeriodSmartBusinessSession getFiscalPeriodSmartBusinessSession(Id businessId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the fiscal period smart business service.- Parameters:
businessId- theIdof theBusiness- Returns:
- a
FiscalPeriodSmartBusinessSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFiscalPeriodSmartBusiness()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFiscalPeriodSmartBusiness()} and {@code supportsVisibleFederation()} are {@code true}
-
getBusinessLookupSession
Gets theOsidSessionassociated with the business lookup service.- Returns:
- a
BusinessLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsBusinessLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBusinessLookup()} is {@code true} .
-
getBusinessQuerySession
Gets theOsidSessionassociated with the business query service.- Returns:
- a
BusinessQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsBusinessQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBusinessQuery()} is {@code true} .
-
getBusinessSearchSession
Gets theOsidSessionassociated with the business search service.- Returns:
- a
BusinessSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsBusinessSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBusinessSearch()} is {@code true} .
-
getBusinessAdminSession
Gets theOsidSessionassociated with the business administrative service.- Returns:
- a
BusinessAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsBusinessAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBusinessAdmin()} is {@code true} .
-
getBusinessNotificationSession
BusinessNotificationSession getBusinessNotificationSession(BusinessReceiver businessReceiver) throws OperationFailedException Gets theOsidSessionassociated with the business notification service.- Parameters:
businessReceiver- the notification callback- Returns:
- a
BusinessNotificationSession - Throws:
NullArgumentException-businessReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsBusinessNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBusinessNotification()} is {@code true} .
-
getBusinessHierarchySession
Gets theOsidSessionassociated with the business hierarchy service.- Returns:
- a
BusinessHierarchySessionfor businesses - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsBusinessHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBusinessHierarchy()} is {@code true} .
-
getBusinessHierarchyDesignSession
Gets theOsidSessionassociated with the business hierarchy design service.- Returns:
- a
HierarchyDesignSessionfor businesses - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsBusinessHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBusinessHierarchyDesign()} is {@code true} .
-
getFinancialsBatchManager
Gets theFinancialsBatchManager.- Returns:
- a
FinancialsBatchManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFinancialsBatch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFinancialsBatch()} is {@code true} .
-
getFinancialsBudgetingManager
Gets theFinancialsBudgetingManager.- Returns:
- a
FinancialsBudgetingManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFinancialsBudgeting()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFinancialsBudgeting()} is {@code true} .
-
getFinancialsPostingManager
Gets theFinancialsPostingManager.- Returns:
- a
FinancialsPostingManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFinancialsPosting()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFinancialsPosting()} is {@code true} .
-