org.osid.financials.posting

Interface FinancialsPostingManager

All Superinterfaces:

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

public interface FinancialsPostingManager
extends OsidManager, FinancialsPostingProfile

The financials posting manager provides access to posting management sessions and provides interoperability tests for various aspects of this service. 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
FinancialsPostingBatchManager	getFinancialsPostingBatchManager() Gets a FinancialsPostingBatchManager.
PostAdminSession	getPostAdminSession() Gets the OsidSession associated with the post administration service.
PostAdminSession	getPostAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the post administration service for the given business.
PostBusinessAssignmentSession	getPostBusinessAssignmentSession() Gets the OsidSession associated with assigning posts to businesses.
PostBusinessSession	getPostBusinessSession() Gets the OsidSession to lookup post/catalog mappings.
PostEntryAdminSession	getPostEntryAdminSession() Gets the OsidSession associated with the post entry administration service.
PostEntryAdminSession	getPostEntryAdminSessionForBusiness(Id businessId) Gets the OsidSession associated with the post entry administration service for the given business.
PostEntryBusinessAssignmentSession	getPostEntryBusinessAssignmentSession() Gets the OsidSession associated with assigning post entries to businesses.
PostEntryBusinessSession	getPostEntryBusinessSession() Gets the OsidSession to lookup entry/catalog mappings.
PostEntryLookupSession	getPostEntryLookupSession() Gets the OsidSession associated with the post entry lookup service.
PostEntryLookupSession	getPostEntryLookupSessionForBusiness(Id businessId) Gets the OsidSession associated with the post entry lookup service for the given business.
PostEntryNotificationSession	getPostEntryNotificationSession(PostEntryReceiver postEntryReceiver) Gets the OsidSession associated with the post entry notification service.
PostEntryNotificationSession	getPostEntryNotificationSessionForBusiness(PostEntryReceiver postEntryReceiver, Id businessId) Gets the OsidSession associated with the post entry notification service for the given business.
PostEntryQuerySession	getPostEntryQuerySession() Gets the OsidSession associated with the post entry query service.
PostEntryQuerySession	getPostEntryQuerySessionForBusiness(Id businessId) Gets the OsidSession associated with the post entry query service for the given business.
PostEntrySearchSession	getPostEntrySearchSession() Gets the OsidSession associated with the post entry search service.
PostEntrySearchSession	getPostEntrySearchSessionForBusiness(Id businessId) Gets the OsidSession associated with the post entry search service for the given business.
PostEntrySmartBusinessSession	getPostEntrySmartBusinessSession(Id businessId) Gets the OsidSession associated with the post entry smart business service.
PostLookupSession	getPostLookupSession() Gets the OsidSession associated with the post lookup service.
PostLookupSession	getPostLookupSessionForBusiness(Id businessId) Gets the OsidSession associated with the post lookup service for the given business.
PostNotificationSession	getPostNotificationSession(PostReceiver postReceiver) Gets the OsidSession associated with the post notification service.
PostNotificationSession	getPostNotificationSessionForBusiness(PostReceiver postReceiver, Id businessId) Gets the OsidSession associated with the post notification service for the given business.
PostQuerySession	getPostQuerySession() Gets the OsidSession associated with the post query service.
PostQuerySession	getPostQuerySessionForBusiness(Id businessId) Gets the OsidSession associated with the post query service for the given business.
PostSearchSession	getPostSearchSession() Gets the OsidSession associated with the post search service.
PostSearchSession	getPostSearchSessionForBusiness(Id businessId) Gets the OsidSession associated with the post search service for the given business.
PostSmartBusinessSession	getPostSmartBusinessSession(Id businessId) Gets the OsidSession associated with the post smart business service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.financials.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()
                                       throws OperationFailedException

Gets the OsidSession associated with the post lookup service.

Returns:

a PostSession

Throws:

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

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

Parameters:

businessId - the Id of the business

Returns:

a PostLookupSession

Throws:

NotFoundException - no Business found by the given Id

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

Gets the OsidSession associated with the post query service.

Returns:

a PostQuerySession

Throws:

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

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

Parameters:

businessId - the Id of the Business

Returns:

a PostQuerySession

Throws:

NotFoundException - no business found by the given Id

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

Gets the OsidSession associated with the post search service.

Returns:

a PostSearchSession

Throws:

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

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

Parameters:

businessId - the Id of the Business

Returns:

a PostSearchSession

Throws:

NotFoundException - no business found by the given Id

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

Gets the OsidSession associated with the post administration service.

Returns:

a PostAdminSession

Throws:

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

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

Parameters:

businessId - the Id of the Business

Returns:

a PostAdminSession

Throws:

NotFoundException - no business found by the given Id

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

Gets the OsidSession associated with the post notification service.

Parameters:

postReceiver - the notification callback

Returns:

a PostNotificationSession

Throws:

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

Returns:

a PostNotificationSession

Throws:

NotFoundException - no business found by the given Id

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

Gets the OsidSession to lookup post/catalog mappings.

Returns:

a PostBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostBusiness() is false

Compliance:

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

getPostBusinessAssignmentSession

PostBusinessAssignmentSession getPostBusinessAssignmentSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with assigning posts to businesses.

Returns:

a PostBusinessAssignmentSession

Throws:

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

Gets the OsidSession associated with the post smart business service.

Parameters:

businessId - the Id of the Business

Returns:

a PostSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

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

Gets the OsidSession associated with the post entry lookup service.

Returns:

a PostEntryLookupSession

Throws:

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

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

Parameters:

businessId - the Id of the Business

Returns:

a PostEntryLookupSession

Throws:

NotFoundException - no Business found by the given Id

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

Gets the OsidSession associated with the post entry query service.

Returns:

a PostEntryQuerySession

Throws:

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

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

Parameters:

businessId - the Id of the Business

Returns:

a PostEntryQuerySession

Throws:

NotFoundException - no business found by the given Id

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

Gets the OsidSession associated with the post entry search service.

Returns:

a PostEntrySearchSession

Throws:

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

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

Parameters:

businessId - the Id of the Business

Returns:

a PostEntrySearchSession

Throws:

NotFoundException - no business found by the given Id

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

Gets the OsidSession associated with the post entry administration service.

Returns:

a PostEntryAdminSession

Throws:

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

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

Parameters:

businessId - the Id of the Business

Returns:

a PostEntryAdminSession

Throws:

NotFoundException - no business found by the given Id

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

Gets the OsidSession associated with the post entry notification service.

Parameters:

postEntryReceiver - the notification callback

Returns:

a PostEntryNotificationSession

Throws:

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

Returns:

a PostEntryNotificationSession

Throws:

NotFoundException - no business found by the given Id

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

Gets the OsidSession to lookup entry/catalog mappings.

Returns:

a PostEntryBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryBusiness() is false

Compliance:

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

getPostEntryBusinessAssignmentSession

PostEntryBusinessAssignmentSession getPostEntryBusinessAssignmentSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning post entries to businesses.

Returns:

a PostEntryBusinessAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostEntryBusinessAssignment() is false

Compliance:

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

getPostEntrySmartBusinessSession

PostEntrySmartBusinessSession getPostEntrySmartBusinessSession(Id businessId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a PostEntrySmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId 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

getFinancialsPostingBatchManager

FinancialsPostingBatchManager getFinancialsPostingBatchManager()
                                                               throws OperationFailedException

Gets a FinancialsPostingBatchManager.

Returns:

a FinancialsPostingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFinancialsPostingBatch() is false

Compliance:

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