Interface FinancialsPostingManager

All Superinterfaces:

AutoCloseable, Closeable, FinancialsPostingProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getPostEntryRecordTypes()	Gets the supported PostEntry record types.
TypeList	getPostEntrySearchRecordTypes()	Gets the supported PostEntry search record types.
TypeList	getPostRecordTypes()	Gets the supported Post record types.
TypeList	getPostSearchRecordTypes()	Gets the supported Post search record types.
boolean	supportsFinancialsPostingBatch()	Tests if a posting batch service is available.
boolean	supportsPostAdmin()	Tests if post administrative service is supported.
boolean	supportsPostBusiness()	Tests if a post cataloging service is supported.
boolean	supportsPostBusinessAssignment()	Tests if a post cataloging service is supported.
boolean	supportsPostEntryAdmin()	Tests if post entry administrative service is supported.
boolean	supportsPostEntryBusiness()	Tests if a post entry cataloging service is supported.
boolean	supportsPostEntryBusinessAssignment()	Tests if a post entry cataloging service is supported.
boolean	supportsPostEntryLookup()	Tests if looking up post entries is supported.
boolean	supportsPostEntryNotification()	Tests if an entry notification service is supported.
boolean	supportsPostEntryQuery()	Tests if querying post entries is supported.
boolean	supportsPostEntryRecordType(Type postEntryRecordType)	Tests if the given PostEntry record type is supported.
boolean	supportsPostEntrySearch()	Tests if searching post entries is supported.
boolean	supportsPostEntrySearchRecordType(Type postEntrySearchRecordType)	Tests if the given PostEntry search record type is supported.
boolean	supportsPostEntrySmartBusiness()	Tests if a post entry smart business session is available.
boolean	supportsPostLookup()	Tests if looking up posts is supported.
boolean	supportsPostNotification()	Tests if a post notification service is supported.
boolean	supportsPostQuery()	Tests if querying posts is supported.
boolean	supportsPostRecordType(Type postRecordType)	Tests if the given Post record type is supported.
boolean	supportsPostSearch()	Tests if searching posts is supported.
boolean	supportsPostSearchRecordType(Type postSearchRecordType)	Tests if the given Post search record type is supported.
boolean	supportsPostSmartBusiness()	Tests if a post smart business session is available.
boolean	supportsVisibleFederation()	Tests if any business federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	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, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsPostLookup()} is {@code 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 {@code supportsPostLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostQuery()} is {@code 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 {@code supportsPostQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostSearch()} is {@code 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 {@code supportsPostSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostAdmin()} is {@code 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 {@code supportsPostAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostNotification()} is {@code 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 {@code supportsPostNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostBusiness()} is {@code 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 {@code supportsPostBusinessAssignment()} is {@code 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 {@code supportsPostSmartBusiness()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostEntryLookup()} is {@code 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 {@code supportsPostEntryLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostEntryQuery()} is {@code 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 {@code supportsPostEntryQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostEntrySearch()} is {@code 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 {@code supportsPostEntrySearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostEntryAdmin()} is {@code 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 {@code supportsPostEntryAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostEntryNotification()} is {@code 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 {@code supportsPostEntryNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPostEntryBusiness()} is {@code 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 {@code supportsPostEntryBusinessAssignment()} is {@code 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 {@code supportsPostEntrySmartBusiness()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsFinancialsPostingBatch()} is {@code true} .