Interface FinancialsPostingProxyManager
- All Superinterfaces:
AutoCloseable, Closeable, FinancialsPostingProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable
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
Modifier and TypeMethodDescriptionGets aFinancialsPostingBatchProxyManager.getPostAdminSession(Proxy proxy) Gets theOsidSessionassociated with the post administration service.getPostAdminSessionForBusiness(Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post administration service for the given business.Gets theOsidSessionassociated with assigning posts to businesses.getPostBusinessSession(Proxy proxy) Gets theOsidSessionto lookup post/catalog mappings.getPostEntryAdminSession(Proxy proxy) Gets theOsidSessionassociated with the post entry administration service.getPostEntryAdminSessionForBusiness(Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post entry administration service for the given business.Gets theOsidSessionassociated with assigning post entries to businesses.getPostEntryBusinessSession(Proxy proxy) Gets theOsidSessionto lookup entry/catalog mappings.getPostEntryLookupSession(Proxy proxy) Gets theOsidSessionassociated with the post entry lookup service.getPostEntryLookupSessionForBusiness(Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post entry lookup service for the given business.getPostEntryNotificationSession(PostEntryReceiver postEntryReceiver, Proxy proxy) Gets theOsidSessionassociated with the post entry notification service.getPostEntryNotificationSessionForBusiness(PostEntryReceiver postEntryReceiver, Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post entry notification service for the given business.getPostEntryQuerySession(Proxy proxy) Gets theOsidSessionassociated with the post entry query service.getPostEntryQuerySessionForBusiness(Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post entry query service for the given business.getPostEntrySearchSession(Proxy proxy) Gets theOsidSessionassociated with the post entry search service.getPostEntrySearchSessionForBusiness(Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post entry search service for the given business.getPostEntrySmartBusinessSession(Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post entry smart business service.getPostLookupSession(Proxy proxy) Gets theOsidSessionassociated with the post lookup service.getPostLookupSessionForBusiness(Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post lookup service for the given business.getPostNotificationSession(PostReceiver postReceiver, Proxy proxy) Gets theOsidSessionassociated with the post notification service.getPostNotificationSessionForBusiness(PostReceiver postReceiver, Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post notification service for the given business.getPostQuerySession(Proxy proxy) Gets theOsidSessionassociated with the post query service.getPostQuerySessionForBusiness(Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post query service for the given business.getPostSearchSession(Proxy proxy) Gets theOsidSessionassociated with the post search service.getPostSearchSessionForBusiness(Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post search service for the given business.getPostSmartBusinessSession(Id businessId, Proxy proxy) Gets theOsidSessionassociated with the post smart business service.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, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedPostEntryrecord types.Gets the supportedPostEntrysearch record types.Gets the supportedPostrecord types.Gets the supportedPostsearch record types.booleanTests if a posting batch service is available.booleanTests if post administrative service is supported.booleanTests if a post cataloging service is supported.booleanTests if a post cataloging service is supported.booleanTests if post entry administrative service is supported.booleanTests if a post entry cataloging service is supported.booleanTests if a post entry cataloging service is supported.booleanTests if looking up post entries is supported.booleanTests if an entry notification service is supported.booleanTests if querying post entries is supported.booleansupportsPostEntryRecordType(Type postEntryRecordType) Tests if the givenPostEntryrecord type is supported.booleanTests if searching post entries is supported.booleansupportsPostEntrySearchRecordType(Type postEntrySearchRecordType) Tests if the givenPostEntrysearch record type is supported.booleanTests if a post entry smart business session is available.booleanTests if looking up posts is supported.booleanTests if a post notification service is supported.booleanTests if querying posts is supported.booleansupportsPostRecordType(Type postRecordType) Tests if the givenPostrecord type is supported.booleanTests if searching posts is supported.booleansupportsPostSearchRecordType(Type postSearchRecordType) Tests if the givenPostsearch record type is supported.booleanTests if a post smart business session is available.booleanTests if any business federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getPostLookupSession
Gets theOsidSessionassociated with the post lookup service.- Parameters:
proxy- proxy- Returns:
- a
PostSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostLookup()} is {@code true} .
-
getPostLookupSessionForBusiness
PostLookupSession getPostLookupSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post lookup service for the given business.- Parameters:
businessId- theIdof the businessproxy- proxy- Returns:
- a
PostLookupSession - Throws:
NotFoundException- noBusinessfound by the givenIdNullArgumentException-proxyorbusinessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostQuerySession
Gets theOsidSessionassociated with the post query service.- Parameters:
proxy- proxy- Returns:
- a
PostQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostQuery()} is {@code true} .
-
getPostQuerySessionForBusiness
PostQuerySession getPostQuerySessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post query service for the given business.- Parameters:
businessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostQuerySession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-proxyorbusinessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostSearchSession
Gets theOsidSessionassociated with the post search service.- Parameters:
proxy- proxy- Returns:
- a
PostSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostSearch()} is {@code true} .
-
getPostSearchSessionForBusiness
PostSearchSession getPostSearchSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post search service for the given business.- Parameters:
businessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostSearchSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-proxyorbusinessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostAdminSession
Gets theOsidSessionassociated with the post administration service.- Parameters:
proxy- proxy- Returns:
- a
PostAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostAdmin()} is {@code true} .
-
getPostAdminSessionForBusiness
PostAdminSession getPostAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post administration service for the given business.- Parameters:
businessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostAdminSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-proxyorbusinessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostNotificationSession
PostNotificationSession getPostNotificationSession(PostReceiver postReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the post notification service.- Parameters:
postReceiver- the notification callbackproxy- proxy- Returns:
- a
PostNotificationSession - Throws:
NullArgumentException-postReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostNotification()} is {@code true} .
-
getPostNotificationSessionForBusiness
PostNotificationSession getPostNotificationSessionForBusiness(PostReceiver postReceiver, Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post notification service for the given business.- Parameters:
postReceiver- the notification callbackbusinessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostNotificationSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-postReceiver, businessIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostBusinessSession
Gets theOsidSessionto lookup post/catalog mappings.- Parameters:
proxy- proxy- Returns:
- a
PostBusinessSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostBusiness()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostBusiness()} is {@code true} .
-
getPostBusinessAssignmentSession
PostBusinessAssignmentSession getPostBusinessAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning posts to businesses.- Parameters:
proxy- proxy- Returns:
- a
PostBusinessAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostBusinessAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostBusinessAssignment()} is {@code true} .
-
getPostSmartBusinessSession
PostSmartBusinessSession getPostSmartBusinessSession(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post smart business service.- Parameters:
businessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostSmartBusinessSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostSmartBusiness()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostSmartBusiness()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostEntryLookupSession
Gets theOsidSessionassociated with the post entry lookup service.- Parameters:
proxy- proxy- Returns:
- a
PostEntryLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntryLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntryLookup()} is {@code true} .
-
getPostEntryLookupSessionForBusiness
PostEntryLookupSession getPostEntryLookupSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post entry lookup service for the given business.- Parameters:
businessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostEntryLookupSession - Throws:
NotFoundException- noBusinessfound by the givenIdNullArgumentException-proxyorbusinessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntryLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntryLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostEntryQuerySession
Gets theOsidSessionassociated with the post entry query service.- Parameters:
proxy- proxy- Returns:
- a
PostEntryQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntryQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntryQuery()} is {@code true} .
-
getPostEntryQuerySessionForBusiness
PostEntryQuerySession getPostEntryQuerySessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post entry query service for the given business.- Parameters:
businessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostEntryQuerySession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntryQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntryQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostEntrySearchSession
Gets theOsidSessionassociated with the post entry search service.- Parameters:
proxy- proxy- Returns:
- a
PostEntrySearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntrySearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntrySearch()} is {@code true} .
-
getPostEntrySearchSessionForBusiness
PostEntrySearchSession getPostEntrySearchSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post entry search service for the given business.- Parameters:
businessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostEntrySearchSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-proxyorbusinessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntrySearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntrySearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostEntryAdminSession
Gets theOsidSessionassociated with the post entry administration service.- Parameters:
proxy- proxy- Returns:
- a
PostEntryAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntryAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntryAdmin()} is {@code true} .
-
getPostEntryAdminSessionForBusiness
PostEntryAdminSession getPostEntryAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post entry administration service for the given business.- Parameters:
businessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostEntryAdminSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-proxyorbusinessIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntryAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntryAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostEntryNotificationSession
PostEntryNotificationSession getPostEntryNotificationSession(PostEntryReceiver postEntryReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the post entry notification service.- Parameters:
postEntryReceiver- the notification callbackproxy- proxy- Returns:
- a
PostEntryNotificationSession - Throws:
NullArgumentException-postEntryReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntryNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntryNotification()} is {@code true} .
-
getPostEntryNotificationSessionForBusiness
PostEntryNotificationSession getPostEntryNotificationSessionForBusiness(PostEntryReceiver postEntryReceiver, Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post entry notification service for the given business.- Parameters:
postEntryReceiver- the notification callbackbusinessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostEntryNotificationSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-postEntryReceiver, businessId, orproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntryNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntryNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getPostEntryBusinessSession
Gets theOsidSessionto lookup entry/catalog mappings.- Parameters:
proxy- proxy- Returns:
- a
PostEntryCatalogSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntryCatalog()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntryCatalog()} is {@code true} .
-
getPostEntryBusinessAssignmentSession
PostEntryBusinessAssignmentSession getPostEntryBusinessAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning post entries to businesses.- Parameters:
proxy- proxy- Returns:
- a
PostEntryCatalogAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntryCatalogAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntryCatalogAssignment()} is {@code true} .
-
getPostEntrySmartBusinessSession
PostEntrySmartBusinessSession getPostEntrySmartBusinessSession(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the post entry smart business service.- Parameters:
businessId- theIdof theBusinessproxy- proxy- Returns:
- a
PostEntrySmartBusinessSession - Throws:
NotFoundException- no business found by the givenIdNullArgumentException-businessIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostEntrySmartBusiness()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostEntrySmartBusiness()} and {@code supportsVisibleFederation()} are {@code true}
-
getFinancialsPostingBatchProxyManager
FinancialsPostingBatchProxyManager getFinancialsPostingBatchProxyManager() throws OperationFailedExceptionGets aFinancialsPostingBatchProxyManager.- Returns:
- a
FinancialsPostingBatchProxyManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFinancialsPostingBatch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFinancialsPostingBatch()} is {@code true} .
-