OSID - osid.financials.posting.FinancialsPostingProxyManager Service Interface Definition

Interface	osid.financials.posting.FinancialsPostingProxyManager
Implements	`osid.OsidProxyManager`
Implements	`osid.financials.posting.FinancialsPostingProfile`
Used By	`osid.financials.FinancialsProxyManager`
Description	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	getPostLookupSession
Description	Gets the `OsidSession` associated with the post lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostLookupSession`		a `PostSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostLookup()` is `true` .
Method	getPostLookupSessionForBusiness
Description	Gets the `OsidSession` associated with the post lookup service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the business
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostLookupSession`		a `PostLookupSession`
Errors	NOT_FOUND		no `Business` found by the given `Id`
	NULL_ARGUMENT		`proxy` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostLookup()` and `supportsVisibleFederation()` are `true`
Method	getPostQuerySession
Description	Gets the `OsidSession` associated with the post query service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostQuerySession`		a `PostQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostQuery()` is `true` .
Method	getPostQuerySessionForBusiness
Description	Gets the `OsidSession` associated with the post query service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostQuerySession`		a `PostQuerySession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`proxy` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostQuery()` and `supportsVisibleFederation()` are `true`
Method	getPostSearchSession
Description	Gets the `OsidSession` associated with the post search service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostSearchSession`		a `PostSearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostSearch()` is `true` .
Method	getPostSearchSessionForBusiness
Description	Gets the `OsidSession` associated with the post search service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostSearchSession`		a `PostSearchSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`proxy` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostSearch()` and `supportsVisibleFederation()` are `true`
Method	getPostAdminSession
Description	Gets the `OsidSession` associated with the post administration service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostAdminSession`		a `PostAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostAdmin()` is `true` .
Method	getPostAdminSessionForBusiness
Description	Gets the `OsidSession` associated with the post administration service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostAdminSession`		a `PostAdminSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`proxy` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostAdmin()` and `supportsVisibleFederation()` are `true`
Method	getPostNotificationSession
Description	Gets the `OsidSession` associated with the post notification service.
Parameters	`osid.financials.posting.PostReceiver`	`postReceiver`	the notification callback
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostNotificationSession`		a `PostNotificationSession`
Errors	NULL_ARGUMENT		`postReceiver` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostNotification()` is `true` .
Method	getPostNotificationSessionForBusiness
Description	Gets the `OsidSession` associated with the post notification service for the given business.
Parameters	`osid.financials.posting.PostReceiver`	`postReceiver`	the notification callback
	`osid.id.Id`	`businessId`	the `Id` of the `Business`
	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostNotificationSession`		a `PostNotificationSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`postReceiver, businessId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostNotification()` and `supportsVisibleFederation()` are `true`
Method	getPostBusinessSession
Description	Gets the `OsidSession` to lookup post/catalog mappings.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostBusinessSession`		a `PostBusinessSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostBusiness()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostBusiness()` is `true` .
Method	getPostBusinessAssignmentSession
Description	Gets the `OsidSession` associated with assigning posts to businesses.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostBusinessAssignmentSession`		a `PostBusinessAssignmentSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostBusinessAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostBusinessAssignment()` is `true` .
Method	getPostSmartBusinessSession
Description	Gets the `OsidSession` associated with the post smart business service.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostSmartBusinessSession`		a `PostSmartBusinessSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostSmartBusiness()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostSmartBusiness()` and `supportsVisibleFederation()` are `true`
Method	getPostEntryLookupSession
Description	Gets the `OsidSession` associated with the post entry lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntryLookupSession`		a `PostEntryLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryLookup()` is `true` .
Method	getPostEntryLookupSessionForBusiness
Description	Gets the `OsidSession` associated with the post entry lookup service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntryLookupSession`		a `PostEntryLookupSession`
Errors	NOT_FOUND		no `Business` found by the given `Id`
	NULL_ARGUMENT		`proxy` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntryLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryLookup()` and `supportsVisibleFederation()` are `true`
Method	getPostEntryQuerySession
Description	Gets the `OsidSession` associated with the post entry query service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntryQuerySession`		a `PostEntryQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryQuery()` is `true` .
Method	getPostEntryQuerySessionForBusiness
Description	Gets the `OsidSession` associated with the post entry query service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntryQuerySession`		a `PostEntryQuerySession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntryQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryQuery()` and `supportsVisibleFederation()` are `true`
Method	getPostEntrySearchSession
Description	Gets the `OsidSession` associated with the post entry search service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntrySearchSession`		a `PostEntrySearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntrySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntrySearch()` is `true` .
Method	getPostEntrySearchSessionForBusiness
Description	Gets the `OsidSession` associated with the post entry search service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntrySearchSession`		a `PostEntrySearchSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`proxy` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntrySearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntrySearch()` and `supportsVisibleFederation()` are `true`
Method	getPostEntryAdminSession
Description	Gets the `OsidSession` associated with the post entry administration service.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntryAdminSession`		a `PostEntryAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntryAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryAdmin()` is `true` .
Method	getPostEntryAdminSessionForBusiness
Description	Gets the `OsidSession` associated with the post entry administration service for the given business.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntryAdminSession`		a `PostEntryAdminSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`proxy` or `businessId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntryAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryAdmin()` and `supportsVisibleFederation()` are `true`
Method	getPostEntryNotificationSession
Description	Gets the `OsidSession` associated with the post entry notification service.
Parameters	`osid.financials.posting.PostEntryReceiver`	`postEntryReceiver`	the notification callback
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntryNotificationSession`		a `PostEntryNotificationSession`
Errors	NULL_ARGUMENT		`postEntryReceiver` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntryNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryNotification()` is `true` .
Method	getPostEntryNotificationSessionForBusiness
Description	Gets the `OsidSession` associated with the post entry notification service for the given business.
Parameters	`osid.financials.posting.PostEntryReceiver`	`postEntryReceiver`	the notification callback
	`osid.id.Id`	`businessId`	the `Id` of the `Business`
	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntryNotificationSession`		a `PostEntryNotificationSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`postEntryReceiver, businessId` , or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntryNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryNotification()` and `supportsVisibleFederation()` are `true`
Method	getPostEntryBusinessSession
Description	Gets the `OsidSession` to lookup entry/catalog mappings.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntryBusinessSession`		a `PostEntryCatalogSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntryCatalog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryCatalog()` is `true` .
Method	getPostEntryBusinessAssignmentSession
Description	Gets the `OsidSession` associated with assigning post entries to businesses.
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntryBusinessAssignmentSession`		a `PostEntryCatalogAssignmentSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntryCatalogAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntryCatalogAssignment()` is `true` .
Method	getPostEntrySmartBusinessSession
Description	Gets the `OsidSession` associated with the post entry smart business service.
Parameters	`osid.id.Id`	`businessId`	the `Id` of the `Business`
Parameters	`osid.proxy.Proxy`	`proxy`	proxy
Return	`osid.financials.posting.PostEntrySmartBusinessSession`		a `PostEntrySmartBusinessSession`
Errors	NOT_FOUND		no business found by the given `Id`
	NULL_ARGUMENT		`businessId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostEntrySmartBusiness()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostEntrySmartBusiness()` and `supportsVisibleFederation()` are `true`
Method	getFinancialsPostingBatchProxyManager
Description	Gets a `FinancialsPostingBatchProxyManager` .
Return	`osid.financials.posting.batch.FinancialsPostingBatchProxyManager`		a `FinancialsPostingBatchProxyManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsFinancialsPostingBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsFinancialsPostingBatch()` is `true` .