OSID - osid.acknowledgement.AcknowledgementProxyManager Service Interface Definition

Interface	osid.acknowledgement.AcknowledgementProxyManager
Implements	`osid.OsidProxyManager`
Implements	`osid.acknowledgement.AcknowledgementProfile`
Used By	`osid.orchestration.OrchestrationManager`
Description	The acknowledgement manager provides access to acknowledgement sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a `Proxy` interface for passing information from a server environment. The sessions included in this manager are: `CreditLookupSession`: a session to lookup credits `CreditQuerySession`: a session for querying credits `CreditSearchSession`: a session to search credits `CreditAdminSession`: a session to manage credits `CreditNotificationSession`: a session to subscribe to notifications of credit changes `CreditBillingSession`: a session to look up credit to billing mappings `CreditBillingAssignmentSession`: a session to manage credit to billing mappings `CreditSmartBillingSession`: a session to manage dynamic credit to billing mappings `BillingLookupSession`: a session to retrieve billings `BillingQuerySession`: a session for querying billings `BillingSearchSession`: a session to search for billings `BillingAdminSession`: a session to create, update and delete billings `BillingNotificationSession`: a session to receive notifications for changes in billings `BillingHierarchyTraversalSession`: a session to traverse hierarchies of billings `BillingHierarchyDesignSession`: a session to manage hierarchies of billings The acknowledgement manager also provides a profile for determing the supported search types supported by this service.
Method	getCreditLookupSession
Description	Gets the `OsidSession` associated with the credit lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditLookupSession`		a `CreditLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditLookup()` is `true`.
Method	getCreditLookupSessionForBilling
Description	Gets the `OsidSession` associated with the credit lookup service for the given billing.
Parameters	`osid.id.Id`	`billingId`	the `Id` of the `Billing`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditLookupSession`		a `CreditLookupSession`
Errors	NOT_FOUND		no `Billing` found by the given `Id`
	NULL_ARGUMENT		`billingId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditLookup()` and `supportsVisibleFederation()` are `true`
Method	getCreditQuerySession
Description	Gets the `OsidSession` associated with the credit query service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditQuerySession`		a `CreditQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditQuery()` is `true`.
Method	getCreditQuerySessionForBilling
Description	Gets the `OsidSession` associated with the credit query service for the given billing.
Parameters	`osid.id.Id`	`billingId`	the `Id` of the `Billing`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditQuerySession`		a `CreditQuerySession`
Errors	NOT_FOUND		no `Billing` found by the given `Id`
	NULL_ARGUMENT		`billingId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditQuery()` and `supportsVisibleFederation()` are `true`
Method	getCreditSearchSession
Description	Gets the `OsidSession` associated with the credit search service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditSearchSession`		a `CreditSearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditSearch()` is `true`.
Method	getCreditSearchSessionForBilling
Description	Gets the `OsidSession` associated with the credit search service for the given billing.
Parameters	`osid.id.Id`	`billingId`	the `Id` of the `Billing`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditSearchSession`		a `CreditSearchSession`
Errors	NOT_FOUND		no `Billing` found by the given `Id`
	NULL_ARGUMENT		`billingId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditSearch()` and `supportsVisibleFederation()` are `true`
Method	getCreditAdminSession
Description	Gets the `OsidSession` associated with the credit administration service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditAdminSession`		a `CreditAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditAdmin()` is `true`.
Method	getCreditAdminSessionForBilling
Description	Gets the `OsidSession` associated with the credit administration service for the given billing.
Parameters	`osid.id.Id`	`billingId`	the `Id` of the `Billing`
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditAdminSession`		a `CreditAdminSession`
Errors	NOT_FOUND		no `Billing` found by the given `Id`
	NULL_ARGUMENT		`billingId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditAdmin()` and `supportsVisibleFederation()` are `true`
Method	getCreditNotificationSession
Description	Gets the `OsidSession` associated with the credit notification service.
Parameters	`osid.acknowledgement.CreditReceiver`	`creditReceiver`	the receiver
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditNotificationSession`		a `CreditNotificationSession`
Errors	NULL_ARGUMENT		`creditReceiver` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditNotification()` is `true`.
Method	getCreditNotificationSessionForBilling
Description	Gets the `OsidSession` associated with the credit notification service for the given billing.
Parameters	`osid.acknowledgement.CreditReceiver`	`creditReceiver`	the receiver
	`osid.id.Id`	`billingId`	the `Id` of the `Billing`
	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditNotificationSession`		a `CreditNotificationSession`
Errors	NOT_FOUND		no `Billing` found by the given `Id`
	NULL_ARGUMENT		`creditReceiver, billingId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditNotification()` and `supportsVisibleFederation()` are `true`
Method	getCreditBillingSession
Description	Gets the session for retrieving credit to billing mappings.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditBillingSession`		a `CreditBillingSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditBilling()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditBilling()` is `true`.
Method	getCreditBillingAssignmentSession
Description	Gets the session for assigning credit to billing mappings.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditBillingAssignmentSession`		a `CreditBillingAssignmentSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditBillingAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditBillingAssignment()` is `true`.
Method	getCreditSmartBillingSession
Description	Gets the session for managing dynamic credit billings for the given billing.
Parameters	`osid.id.Id`	`billingId`	the `Id` of a billing
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.CreditSmartBillingSession`		a `CreditSmartBillingSession`
Errors	NOT_FOUND		`billingId` is not found
	NULL_ARGUMENT		`billingId` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsCreditSmartBilling()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditSmartBilling()` is `true`.
Method	getBillingLookupSession
Description	Gets the `OsidSession` associated with the billing lookup service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.BillingLookupSession`		a `BillingLookupSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBillingLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBillingLookup()` is `true`.
Method	getBillingQuerySession
Description	Gets the `OsidSession` associated with the billing query service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.BillingQuerySession`		a `BillingQuerySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBillingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBillingQuery()` is `true`.
Method	getBillingSearchSession
Description	Gets the `OsidSession` associated with the billing search service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.BillingSearchSession`		a `BillingSearchSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBillingSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBillingSearch()` is `true`.
Method	getBillingAdminSession
Description	Gets the `OsidSession` associated with the billing administrative service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.BillingAdminSession`		a `BillingAdminSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBillingAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBillingAdmin()` is `true`.
Method	getBillingNotificationSession
Description	Gets the `OsidSession` associated with the billing notification service.
Parameters	`osid.acknowledgement.BillingReceiver`	`billingReceiver`	the receiver
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.BillingNotificationSession`		a `BillingNotificationSession`
Errors	NULL_ARGUMENT		`billingReceiver` or `proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBillingNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBillingNotification()` is `true`.
Method	getBillingHierarchySession
Description	Gets the `OsidSession` associated with the billing hierarchy service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.BillingHierarchySession`		a `BillingHierarchySession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBillingHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBillingHierarchy()` is `true`.
Method	getBillingHierarchyDesignSession
Description	Gets the `OsidSession` associated with the billing hierarchy design service.
Parameters	`osid.proxy.Proxy`	`proxy`	a proxy
Return	`osid.acknowledgement.BillingHierarchyDesignSession`		a `BillingHierarchyDesignSession`
Errors	NULL_ARGUMENT		`proxy` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsBillingHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBillingHierarchyDesign()` is `true`.
Method	getAcknowledgementBatchProxyManager
Description	Gets an `AcknowledgementBatchProxyManager`.
Return	`osid.acknowledgement.batch.AcknowledgementBatchProxyManager`		an `AcknowledgementBatchProxyManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsAcknowledgementBach()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAcknowledgementBatch()` is `true`.