org.osid.financials.posting

Interface FinancialsPostingProxyManager

All Superinterfaces:

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

public interface FinancialsPostingProxyManager
extends OsidProxyManager, FinancialsPostingProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
FinancialsPostingBatchProxyManager	getFinancialsPostingBatchProxyManager() Gets a FinancialsPostingBatchProxyManager.
PostAdminSession	getPostAdminSession(Proxy proxy) Gets the OsidSession associated with the post administration service.
PostAdminSession	getPostAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the post administration service for the given business.
PostBusinessAssignmentSession	getPostBusinessAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning posts to businesses.
PostBusinessSession	getPostBusinessSession(Proxy proxy) Gets the OsidSession to lookup post/catalog mappings.
PostEntryAdminSession	getPostEntryAdminSession(Proxy proxy) Gets the OsidSession associated with the post entry administration service.
PostEntryAdminSession	getPostEntryAdminSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the post entry administration service for the given business.
PostEntryBusinessAssignmentSession	getPostEntryBusinessAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning post entries to businesses.
PostEntryBusinessSession	getPostEntryBusinessSession(Proxy proxy) Gets the OsidSession to lookup entry/catalog mappings.
PostEntryLookupSession	getPostEntryLookupSession(Proxy proxy) Gets the OsidSession associated with the post entry lookup service.
PostEntryLookupSession	getPostEntryLookupSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the post entry lookup service for the given business.
PostEntryNotificationSession	getPostEntryNotificationSession(PostEntryReceiver postEntryReceiver, Proxy proxy) Gets the OsidSession associated with the post entry notification service.
PostEntryNotificationSession	getPostEntryNotificationSessionForBusiness(PostEntryReceiver postEntryReceiver, Id businessId, Proxy proxy) Gets the OsidSession associated with the post entry notification service for the given business.
PostEntryQuerySession	getPostEntryQuerySession(Proxy proxy) Gets the OsidSession associated with the post entry query service.
PostEntryQuerySession	getPostEntryQuerySessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the post entry query service for the given business.
PostEntrySearchSession	getPostEntrySearchSession(Proxy proxy) Gets the OsidSession associated with the post entry search service.
PostEntrySearchSession	getPostEntrySearchSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the post entry search service for the given business.
PostEntrySmartBusinessSession	getPostEntrySmartBusinessSession(Id businessId, Proxy proxy) Gets the OsidSession associated with the post entry smart business service.
PostLookupSession	getPostLookupSession(Proxy proxy) Gets the OsidSession associated with the post lookup service.
PostLookupSession	getPostLookupSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the post lookup service for the given business.
PostNotificationSession	getPostNotificationSession(PostReceiver postReceiver, Proxy proxy) Gets the OsidSession associated with the post notification service.
PostNotificationSession	getPostNotificationSessionForBusiness(PostReceiver postReceiver, Id businessId, Proxy proxy) Gets the OsidSession associated with the post notification service for the given business.
PostQuerySession	getPostQuerySession(Proxy proxy) Gets the OsidSession associated with the post query service.
PostQuerySession	getPostQuerySessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the post query service for the given business.
PostSearchSession	getPostSearchSession(Proxy proxy) Gets the OsidSession associated with the post search service.
PostSearchSession	getPostSearchSessionForBusiness(Id businessId, Proxy proxy) Gets the OsidSession associated with the post search service for the given business.
PostSmartBusinessSession	getPostSmartBusinessSession(Id businessId, Proxy proxy) Gets the OsidSession associated with the post smart business service.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.financials.posting.FinancialsPostingProfile

getPostEntryRecordTypes, getPostEntrySearchRecordTypes, getPostRecordTypes, getPostSearchRecordTypes, supportsFinancialsPostingBatch, supportsPostAdmin, supportsPostBusiness, supportsPostBusinessAssignment, supportsPostEntryAdmin, supportsPostEntryBusiness, supportsPostEntryBusinessAssignment, supportsPostEntryLookup, supportsPostEntryNotification, supportsPostEntryQuery, supportsPostEntryRecordType, supportsPostEntrySearch, supportsPostEntrySearchRecordType, supportsPostEntrySmartBusiness, supportsPostLookup, supportsPostNotification, supportsPostQuery, supportsPostRecordType, supportsPostSearch, supportsPostSearchRecordType, supportsPostSmartBusiness, 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

getPostLookupSession

PostLookupSession getPostLookupSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the post lookup service.

Parameters:

proxy - proxy

Returns:

a PostSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostLookup() is false

Compliance:

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

getPostLookupSessionForBusiness

PostLookupSession getPostLookupSessionForBusiness(Id businessId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - proxy

Returns:

a PostLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostLookup() or supportsVisibleFederation() is false

Compliance:

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

getPostQuerySession

PostQuerySession getPostQuerySession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the post query service.

Parameters:

proxy - proxy

Returns:

a PostQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostQuery() is false

Compliance:

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

getPostQuerySessionForBusiness

PostQuerySession getPostQuerySessionForBusiness(Id businessId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PostQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostQuery() or supportsVisibleFederation() is false

Compliance:

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

getPostSearchSession

PostSearchSession getPostSearchSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the post search service.

Parameters:

proxy - proxy

Returns:

a PostSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostSearch() is false

Compliance:

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

getPostSearchSessionForBusiness

PostSearchSession getPostSearchSessionForBusiness(Id businessId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PostSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostSearch() or supportsVisibleFederation() is false

Compliance:

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

getPostAdminSession

PostAdminSession getPostAdminSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the post administration service.

Parameters:

proxy - proxy

Returns:

a PostAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostAdmin() is false

Compliance:

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

getPostAdminSessionForBusiness

PostAdminSession getPostAdminSessionForBusiness(Id businessId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PostAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPostNotificationSession

PostNotificationSession getPostNotificationSession(PostReceiver postReceiver,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the post notification service.

Parameters:

postReceiver - the notification callback

proxy - proxy

Returns:

a PostNotificationSession

Throws:

NullArgumentException - postReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostNotification() is false

Compliance:

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

getPostNotificationSessionForBusiness

PostNotificationSession getPostNotificationSessionForBusiness(PostReceiver postReceiver,
                                                            Id businessId,
                                                            Proxy proxy)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

postReceiver - the notification callback

businessId - the Id of the Business

proxy - proxy

Returns:

a PostNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - postReceiver, businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostNotification() or supportsVisibleFederation() is false

Compliance:

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

getPostBusinessSession

PostBusinessSession getPostBusinessSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession to lookup post/catalog mappings.

Parameters:

proxy - proxy

Returns:

a PostBusinessSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostBusiness() is false

Compliance:

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

getPostBusinessAssignmentSession

PostBusinessAssignmentSession getPostBusinessAssignmentSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with assigning posts to businesses.

Parameters:

proxy - proxy

Returns:

a PostBusinessAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostBusinessAssignment() is false

Compliance:

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

getPostSmartBusinessSession

PostSmartBusinessSession getPostSmartBusinessSession(Id businessId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the post smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PostSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostSmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getPostEntryLookupSession

PostEntryLookupSession getPostEntryLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the post entry lookup service.

Parameters:

proxy - proxy

Returns:

an PostEntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryLookup() is false

Compliance:

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

getPostEntryLookupSessionForBusiness

PostEntryLookupSession getPostEntryLookupSessionForBusiness(Id businessId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an PostEntryLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getPostEntryQuerySession

PostEntryQuerySession getPostEntryQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the post entry query service.

Parameters:

proxy - proxy

Returns:

an PostEntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryQuery() is false

Compliance:

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

getPostEntryQuerySessionForBusiness

PostEntryQuerySession getPostEntryQuerySessionForBusiness(Id businessId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an PostEntryQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getPostEntrySearchSession

PostEntrySearchSession getPostEntrySearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the post entry search service.

Parameters:

proxy - proxy

Returns:

an PostEntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntrySearch() is false

Compliance:

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

getPostEntrySearchSessionForBusiness

PostEntrySearchSession getPostEntrySearchSessionForBusiness(Id businessId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an PostEntrySearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getPostEntryAdminSession

PostEntryAdminSession getPostEntryAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the post entry administration service.

Parameters:

proxy - proxy

Returns:

an PostEntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryAdmin() is false

Compliance:

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

getPostEntryAdminSessionForBusiness

PostEntryAdminSession getPostEntryAdminSessionForBusiness(Id businessId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an PostEntryAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPostEntryNotificationSession

PostEntryNotificationSession getPostEntryNotificationSession(PostEntryReceiver postEntryReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the post entry notification service.

Parameters:

postEntryReceiver - the notification callback

proxy - proxy

Returns:

an PostEntryNotificationSession

Throws:

NullArgumentException - postEntryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryNotification() is false

Compliance:

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

getPostEntryNotificationSessionForBusiness

PostEntryNotificationSession getPostEntryNotificationSessionForBusiness(PostEntryReceiver postEntryReceiver,
                                                                      Id businessId,
                                                                      Proxy proxy)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

postEntryReceiver - the notification callback

businessId - the Id of the Business

proxy - proxy

Returns:

an PostEntryNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - postEntryReceiver, businessId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getPostEntryBusinessSession

PostEntryBusinessSession getPostEntryBusinessSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession to lookup entry/catalog mappings.

Parameters:

proxy - proxy

Returns:

an PostEntryCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryCatalog() is false

Compliance:

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

getPostEntryBusinessAssignmentSession

PostEntryBusinessAssignmentSession getPostEntryBusinessAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning post entries to businesses.

Parameters:

proxy - proxy

Returns:

an PostEntryCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryCatalogAssignment() is false

Compliance:

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

getPostEntrySmartBusinessSession

PostEntrySmartBusinessSession getPostEntrySmartBusinessSession(Id businessId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an PostEntrySmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntrySmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getFinancialsPostingBatchProxyManager

FinancialsPostingBatchProxyManager getFinancialsPostingBatchProxyManager()
                                                                         throws OperationFailedException

Gets a FinancialsPostingBatchProxyManager.

Returns:

a FinancialsPostingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFinancialsPostingBatch() is false

Compliance:

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