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 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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
PostLookupSession getPostLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the post lookup
service.proxy
- proxy PostSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostLookup()
is false
optional
- This method must be implemented if
supportsPostLookup()
is true.
PostLookupSession getPostLookupSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post lookup
service for the given business.businessId
- the Id
of the businessproxy
- proxy PostLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPostLookup()
and
supportsVisibleFederation()
are true
PostQuerySession getPostQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the post query
service.proxy
- proxy PostQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostQuery()
is false
optional
- This method must be implemented if
supportsPostQuery()
is true.
PostQuerySession getPostQuerySessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post query
service for the given business.businessId
- the Id
of the Business
proxy
- proxy PostQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPostQuery()
and
supportsVisibleFederation()
are true
PostSearchSession getPostSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the post search
service.proxy
- proxy PostSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostSearch()
is false
optional
- This method must be implemented if
supportsPostSearch()
is true.
PostSearchSession getPostSearchSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post search
service for the given business.businessId
- the Id
of the Business
proxy
- proxy PostSearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPostSearch()
and
supportsVisibleFederation()
are true
PostAdminSession getPostAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the post
administration service.proxy
- proxy PostAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostAdmin()
is false
optional
- This method must be implemented if
supportsPostAdmin()
is true.
PostAdminSession getPostAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post
administration service for the given business.businessId
- the Id
of the Business
proxy
- proxy PostAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPostAdmin()
and
supportsVisibleFederation()
are true
PostNotificationSession getPostNotificationSession(PostReceiver postReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the post
notification service.postReceiver
- the notification callbackproxy
- proxy PostNotificationSession
NullArgumentException
- postReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostNotification()
is false
optional
- This method must be implemented if
supportsPostNotification()
is true.
PostNotificationSession getPostNotificationSessionForBusiness(PostReceiver postReceiver, Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post
notification service for the given business.postReceiver
- the notification callbackbusinessId
- the Id
of the Business
proxy
- proxy PostNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- postReceiver, businessId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPostNotification()
and
supportsVisibleFederation()
are true
PostBusinessSession getPostBusinessSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup post/catalog mappings.proxy
- proxy PostBusinessSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPostBusiness()
is false
optional
- This method must be implemented if
supportsPostBusiness()
is true.
PostBusinessAssignmentSession getPostBusinessAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning posts to
businesses.proxy
- proxy PostBusinessAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostBusinessAssignment()
is false
optional
- This method must be implemented if
supportsPostBusinessAssignment()
is true.
PostSmartBusinessSession getPostSmartBusinessSession(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post smart
business service.businessId
- the Id
of the Business
proxy
- proxy PostSmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostSmartBusiness()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPostSmartBusiness()
and
supportsVisibleFederation()
are true
PostEntryLookupSession getPostEntryLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the post entry
lookup service.proxy
- proxy PostEntryLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntryLookup()
is false
optional
- This method must be implemented if
supportsPostEntryLookup()
is true.
PostEntryLookupSession getPostEntryLookupSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post entry
lookup service for the given business.businessId
- the Id
of the Business
proxy
- proxy PostEntryLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntryLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPostEntryLookup()
and
supportsVisibleFederation()
are true
PostEntryQuerySession getPostEntryQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the post entry
query service.proxy
- proxy PostEntryQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntryQuery()
is false
optional
- This method must be implemented if
supportsPostEntryQuery()
is true.
PostEntryQuerySession getPostEntryQuerySessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post entry
query service for the given business.businessId
- the Id
of the Business
proxy
- proxy PostEntryQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntryQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPostEntryQuery()
and
supportsVisibleFederation()
are true
PostEntrySearchSession getPostEntrySearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the post entry
search service.proxy
- proxy PostEntrySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntrySearch()
is false
optional
- This method must be implemented if
supportsPostEntrySearch()
is true.
PostEntrySearchSession getPostEntrySearchSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post entry
search service for the given business.businessId
- the Id
of the Business
proxy
- proxy PostEntrySearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntrySearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPostEntrySearch()
and
supportsVisibleFederation()
are true
PostEntryAdminSession getPostEntryAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the post entry
administration service.proxy
- proxy PostEntryAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntryAdmin()
is false
optional
- This method must be implemented if
supportsPostEntryAdmin()
is true.
PostEntryAdminSession getPostEntryAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post entry
administration service for the given business.businessId
- the Id
of the Business
proxy
- proxy PostEntryAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntryAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPostEntryAdmin()
and
supportsVisibleFederation()
are true
PostEntryNotificationSession getPostEntryNotificationSession(PostEntryReceiver postEntryReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the post entry
notification service.postEntryReceiver
- the notification callbackproxy
- proxy PostEntryNotificationSession
NullArgumentException
- postEntryReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntryNotification()
is false
optional
- This method must be implemented if
supportsPostEntryNotification()
is true.
PostEntryNotificationSession getPostEntryNotificationSessionForBusiness(PostEntryReceiver postEntryReceiver, Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post entry
notification service for the given business.postEntryReceiver
- the notification callbackbusinessId
- the Id
of the Business
proxy
- proxy PostEntryNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- postEntryReceiver,
businessId,
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntryNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPostEntryNotification()
and
supportsVisibleFederation()
are true
PostEntryBusinessSession getPostEntryBusinessSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup entry/catalog mappings.proxy
- proxy PostEntryCatalogSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntryCatalog()
is false
optional
- This method must be implemented if
supportsPostEntryCatalog()
is true.
PostEntryBusinessAssignmentSession getPostEntryBusinessAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning post
entries to businesses.proxy
- proxy PostEntryCatalogAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntryCatalogAssignment()
is false
optional
- This method must be implemented if
supportsPostEntryCatalogAssignment()
is
true.
PostEntrySmartBusinessSession getPostEntrySmartBusinessSession(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the post entry
smart business service.businessId
- the Id
of the Business
proxy
- proxy PostEntrySmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostEntrySmartBusiness()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPostEntrySmartBusiness()
and
supportsVisibleFederation()
are true
FinancialsPostingBatchProxyManager getFinancialsPostingBatchProxyManager() throws OperationFailedException
FinancialsPostingBatchProxyManager.
FinancialsPostingBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsFinancialsPostingBatch()
is false
optional
- This method must be implemented if
supportsFinancialsPostingBatch()
is true.