Interface | osid.financials.posting.FinancialsPostingProxyManager | ||
---|---|---|---|
Implements | osid.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
| ||
Method | getPostLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostLookupSession | a PostSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostLookup() is false | ||
Compliance | optional | This method must be implemented if supportsPostLookup() is
true. | |
Method | getPostLookupSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostLookupSession | a PostLookupSession | |
Errors | NOT_FOUND | no Business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPostLookup() and
supportsVisibleFederation() are true | |
Method | getPostQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostQuerySession | a PostQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostQuery() is false | ||
Compliance | optional | This method must be implemented if supportsPostQuery() is
true. | |
Method | getPostQuerySessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostQuerySession | a PostQuerySession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPostQuery() and
supportsVisibleFederation() are true | |
Method | getPostSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostSearchSession | a PostSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostSearch() is false | ||
Compliance | optional | This method must be implemented if supportsPostSearch() is
true. | |
Method | getPostSearchSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostSearchSession | a PostSearchSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPostSearch() and
supportsVisibleFederation() are true | |
Method | getPostAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostAdminSession | a PostAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPostAdmin() is
true. | |
Method | getPostAdminSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostAdminSession | a PostAdminSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPostAdmin() and
supportsVisibleFederation() are true | |
Method | getPostNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.financials.posting.PostReceiver | postReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostNotificationSession | a PostNotificationSession | |
Errors | NULL_ARGUMENT | postReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostNotification() is false | ||
Compliance | optional | This method must be implemented if supportsPostNotification()
is true. | |
Method | getPostNotificationSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.financials.posting.PostReceiver | postReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostNotificationSession | a PostNotificationSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | postReceiver, businessId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPostNotification()
and supportsVisibleFederation() are true | |
Method | getPostBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostBusinessSession | a PostBusinessSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostBusiness() is false | ||
Compliance | optional | This method must be implemented if supportsPostBusiness() is
true. | |
Method | getPostBusinessAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostBusinessAssignmentSession | a PostBusinessAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostBusinessAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsPostBusinessAssignment()
is true. | |
Method | getPostSmartBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostSmartBusinessSession | a PostSmartBusinessSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | businessId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostSmartBusiness() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPostSmartBusiness()
and supportsVisibleFederation() are true | |
Method | getPostEntryLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostEntryLookupSession | an PostEntryLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntryLookup() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntryLookup()
is true. | |
Method | getPostEntryLookupSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostEntryLookupSession | an PostEntryLookupSession | |
Errors | NOT_FOUND | no Business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntryLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntryLookup()
and supportsVisibleFederation() are true | |
Method | getPostEntryQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostEntryQuerySession | an PostEntryQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntryQuery() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntryQuery()
is true. | |
Method | getPostEntryQuerySessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostEntryQuerySession | an PostEntryQuerySession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | businessId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntryQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntryQuery()
and supportsVisibleFederation() are true | |
Method | getPostEntrySearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostEntrySearchSession | an PostEntrySearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntrySearch() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntrySearch()
is true. | |
Method | getPostEntrySearchSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostEntrySearchSession | an PostEntrySearchSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntrySearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntrySearch()
and supportsVisibleFederation() are true | |
Method | getPostEntryAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostEntryAdminSession | an PostEntryAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntryAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntryAdmin()
is true. | |
Method | getPostEntryAdminSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostEntryAdminSession | an PostEntryAdminSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntryAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntryAdmin()
and supportsVisibleFederation() are true | |
Method | getPostEntryNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.financials.posting.PostEntryReceiver | postEntryReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostEntryNotificationSession | an PostEntryNotificationSession | |
Errors | NULL_ARGUMENT | postEntryReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntryNotification() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntryNotification()
is true. | |
Method | getPostEntryNotificationSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.financials.posting.PostEntryReceiver | postEntryReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostEntryNotificationSession | an PostEntryNotificationSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | postEntryReceiver, businessId, or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntryNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntryNotification()
and supportsVisibleFederation() are true | |
Method | getPostEntryBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostEntryBusinessSession | an PostEntryCatalogSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntryCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntryCatalog()
is true. | |
Method | getPostEntryBusinessAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.financials.posting.PostEntryBusinessAssignmentSession | an PostEntryCatalogAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntryCatalogAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsPostEntryCatalogAssignment() is true. | |
Method | getPostEntrySmartBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.financials.posting.PostEntrySmartBusinessSession | an PostEntrySmartBusinessSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | businessId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPostEntrySmartBusiness() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPostEntrySmartBusiness()
and supportsVisibleFederation() are true | |
Method | getFinancialsPostingBatchProxyManager | ||
Description |
Gets a | ||
Return | osid.financials.posting.batch.FinancialsPostingBatchProxyManager | a FinancialsPostingBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFinancialsPostingBatch() is false | ||
Compliance | optional | This method must be implemented if supportsFinancialsPostingBatch()
is true. |