OSID Logo
OSID Specifications
financials posting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.posting.FinancialsPostingProxyManager
Implementsosid.OsidProxyManager
osid.financials.posting.FinancialsPostingProfile
Description

The financials posting manager provides access to posting management sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for the purposes of passing information within a server application environment. The sessions included in this manager are:

  • PostLookupSession: a session to retrieve posts
  • PostQuerySession: a session to query posts
  • PostSearchSession: a session to search for posts
  • PostAdminSession: a session to create and delete posts
  • PostNotificationSession: a session to receive notifications pertaining to post changes
  • PostBusinessSession: a session to look up post to business mappings
  • PostBusinessAssignmentSession: a session to manage post to business mappings
  • PostSmartBusinessSession: a session to manage dynamic businesses of posts
  • PostEntryLookupSession: a session to retrieve entries
  • PostEntryLookupSession: a session to query entries
  • PostEntrySearchSession: a session to search for entries
  • PostEntryAdminSession: a session to create and delete entries
  • PostEntryNotificationSession: a session to receive notifications pertaining to post entry changes
  • PostEntryBusinessSession: a session to look up post entry to business mappings
  • PostEntryBusinessAssignmentSession: a session to manage post entry to business mappings
  • PostEntrySmartBusinessAssignmentSession: a session to manage dynamic businesses of entries
MethodgetPostLookupSession
Description

Gets the OsidSession associated with the post lookup service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostLookupSessiona PostSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostLookup() is false
ComplianceoptionalThis method must be implemented if supportsPostLookup() is true.
MethodgetPostLookupSessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostLookupSessiona PostLookupSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostLookup() and supportsVisibleFederation() are true
MethodgetPostQuerySession
Description

Gets the OsidSession associated with the post query service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostQuerySessiona PostQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostQuery() is false
ComplianceoptionalThis method must be implemented if supportsPostQuery() is true.
MethodgetPostQuerySessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostQuerySessiona PostQuerySession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostQuery() and supportsVisibleFederation() are true
MethodgetPostSearchSession
Description

Gets the OsidSession associated with the post search service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostSearchSessiona PostSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostSearch() is false
ComplianceoptionalThis method must be implemented if supportsPostSearch() is true.
MethodgetPostSearchSessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostSearchSessiona PostSearchSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostSearch() and supportsVisibleFederation() are true
MethodgetPostAdminSession
Description

Gets the OsidSession associated with the post administration service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostAdminSessiona PostAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPostAdmin() is true.
MethodgetPostAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostAdminSessiona PostAdminSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostAdmin() and supportsVisibleFederation() are true
MethodgetPostNotificationSession
Description

Gets the OsidSession associated with the post notification service.

Parametersosid.financials.posting.PostReceiverpostReceiverthe notification callback
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostNotificationSessiona PostNotificationSession
ErrorsNULL_ARGUMENT postReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostNotification() is false
ComplianceoptionalThis method must be implemented if supportsPostNotification() is true.
MethodgetPostNotificationSessionForBusiness
Description

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

Parametersosid.financials.posting.PostReceiverpostReceiverthe notification callback
osid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostNotificationSessiona PostNotificationSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT postReceiver, businessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostNotification() and supportsVisibleFederation() are true
MethodgetPostBusinessSession
Description

Gets the OsidSession to lookup post/catalog mappings.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostBusinessSessiona PostBusinessSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostBusiness() is false
ComplianceoptionalThis method must be implemented if supportsPostBusiness() is true.
MethodgetPostBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning posts to businesses.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostBusinessAssignmentSessiona PostBusinessAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostBusinessAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPostBusinessAssignment() is true.
MethodgetPostSmartBusinessSession
Description

Gets the OsidSession associated with the post smart business service.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostSmartBusinessSessiona PostSmartBusinessSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostSmartBusiness() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostSmartBusiness() and supportsVisibleFederation() are true
MethodgetPostEntryLookupSession
Description

Gets the OsidSession associated with the post entry lookup service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntryLookupSessionan PostEntryLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntryLookup() is false
ComplianceoptionalThis method must be implemented if supportsPostEntryLookup() is true.
MethodgetPostEntryLookupSessionForBusiness
Description

Gets the OsidSession associated with the post entry lookup service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntryLookupSessionan PostEntryLookupSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntryLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostEntryLookup() and supportsVisibleFederation() are true
MethodgetPostEntryQuerySession
Description

Gets the OsidSession associated with the post entry query service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntryQuerySessionan PostEntryQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsPostEntryQuery() is true.
MethodgetPostEntryQuerySessionForBusiness
Description

Gets the OsidSession associated with the post entry query service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntryQuerySessionan PostEntryQuerySession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntryQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostEntryQuery() and supportsVisibleFederation() are true
MethodgetPostEntrySearchSession
Description

Gets the OsidSession associated with the post entry search service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntrySearchSessionan PostEntrySearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntrySearch() is false
ComplianceoptionalThis method must be implemented if supportsPostEntrySearch() is true.
MethodgetPostEntrySearchSessionForBusiness
Description

Gets the OsidSession associated with the post entry search service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntrySearchSessionan PostEntrySearchSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntrySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostEntrySearch() and supportsVisibleFederation() are true
MethodgetPostEntryAdminSession
Description

Gets the OsidSession associated with the post entry administration service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntryAdminSessionan PostEntryAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntryAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPostEntryAdmin() is true.
MethodgetPostEntryAdminSessionForBusiness
Description

Gets the OsidSession associated with the post entry administration service for the given business.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntryAdminSessionan PostEntryAdminSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntryAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostEntryAdmin() and supportsVisibleFederation() are true
MethodgetPostEntryNotificationSession
Description

Gets the OsidSession associated with the post entry notification service.

Parametersosid.financials.posting.PostEntryReceiverpostEntryReceiverthe notification callback
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntryNotificationSessionan PostEntryNotificationSession
ErrorsNULL_ARGUMENT postEntryReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntryNotification() is false
ComplianceoptionalThis method must be implemented if supportsPostEntryNotification() is true.
MethodgetPostEntryNotificationSessionForBusiness
Description

Gets the OsidSession associated with the post entry notification service for the given business.

Parametersosid.financials.posting.PostEntryReceiverpostEntryReceiverthe notification callback
osid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntryNotificationSessionan PostEntryNotificationSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT postEntryReceiver, businessId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntryNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostEntryNotification() and supportsVisibleFederation() are true
MethodgetPostEntryBusinessSession
Description

Gets the OsidSession to lookup entry/catalog mappings.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntryBusinessSessionan PostEntryCatalogSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntryCatalog() is false
ComplianceoptionalThis method must be implemented if supportsPostEntryCatalog() is true.
MethodgetPostEntryBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning post entries to businesses.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntryBusinessAssignmentSessionan PostEntryCatalogAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntryCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPostEntryCatalogAssignment() is true.
MethodgetPostEntrySmartBusinessSession
Description

Gets the OsidSession associated with the post entry smart business service.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.financials.posting.PostEntrySmartBusinessSessionan PostEntrySmartBusinessSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPostEntrySmartBusiness() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPostEntrySmartBusiness() and supportsVisibleFederation() are true
MethodgetFinancialsPostingBatchProxyManager
Description

Gets a FinancialsPostingBatchProxyManager.

Returnosid.financials.posting.batch.FinancialsPostingBatchProxyManagera FinancialsPostingBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFinancialsPostingBatch() is false
ComplianceoptionalThis method must be implemented if supportsFinancialsPostingBatch() is true.