OSID - osid.billing.payment.SummarySession Service Interface Definition

Interface	osid.billing.payment.SummarySession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving payment summaries. This lookup session defines several views: comparative summary view: elements may be silently omitted or re-ordered plenary summary view: provides a complete result set or is an error condition isolated business view: All summary methods in this session operate, retrieve and pertain to summaries defined explicitly in the current business. Using an isolated view is useful for managing `Summaries` with the `SummaryAdminSession.` federated business view: All summary lookup methods in this session operate, retrieve and pertain to all summaries defined in this business and any other summaries implicitly available in this business through business inheritence. The methods `useFederatedBusinessView()` and `useIsolatedBusinessView()` behave as a radio group and one should be selected before invoking any lookup methods. Summaries may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Summary.`
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.billing.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupSummaries
Description	Tests if this user can perform `Summary` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeSummaryView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenarySummaryView
Description	A complete view of the `Summary` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedBusinessView
Description	Federates the view for methods in this session. A federated view will include summaries in catalogs which are children of this catalog in the business hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBusinessView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this business only.
Compliance	`mandatory`		This method is must be implemented.
Method	getCurrentSummaryForCustomer
Description	Gets the current `Summary` for the given customer.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Return	`osid.billing.payment.Summary`		the returned `Summary`
Errors	NOT_FOUND		`customerId` is not found
	NULL_ARGUMENT		`customerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummariesForCustomer
Description	Gets a `SummaryList` for the given customer. In plenary mode, the returned list contains all known summaries or an error results. Otherwise, the returned list may contain only those summaries that are accessible through this session.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Return	`osid.billing.payment.SummaryList`		the returned `Summary` list
Errors	NULL_ARGUMENT		`customerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummariesByPeriod
Description	Gets a `SummaryList` for the given period. In plenary mode, the returned list contains all known summaries or an error results. Otherwise, the returned list may contain only those summaries that are accessible through this session.
Parameters	`osid.id.Id`	`periodId`	a period `Id`
Return	`osid.billing.payment.SummaryList`		the returned `Summary` list
Errors	NULL_ARGUMENT		`periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummariesByPeriodForCustomer
Description	Gets a `SummaryList` for the given customer and billing period. In plenary mode, the returned list contains all known summaries or an error results. Otherwise, the returned list may contain only those summaries that are accessible through this session.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Parameters	`osid.id.Id`	`periodId`	a period `Id`
Return	`osid.billing.payment.SummaryList`		the returned `Summary` list
Errors	NULL_ARGUMENT		`customerId` or `periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPastDueSummaries
Description	Gets a `SummaryList` of currently past due payments. In plenary mode, the returned list contains all known summaries or an error results. Otherwise, the returned list may contain only those summaries that are accessible through this session.
Return	`osid.billing.payment.SummaryList`		the returned `Summary` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSummaries
Description	Gets all `Summaries.` In plenary mode, the returned list contains all known summaries or an error results. Otherwise, the returned list may contain only those summaries that are accessible through this session.
Return	`osid.billing.payment.SummaryList`		a list of `Summary`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.