OSID - osid.billing.CustomerLookupSession Service Interface Definition

Interface	osid.billing.CustomerLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving customers. A `Customer` is a `Resource` related to the billing system. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated business view: All customer methods in this session operate, retrieve and pertain to customers defined explicitly in the current business. Using an isolated view is useful for managing `Customers` with the `CustomerAdminSession.` federated business view: All customer lookup methods in this session operate, retrieve and pertain to all customers defined in this business and any other customers implicitly available in this business through business inheritence. effective customer view: All customer lookup methods return customers where the current date falls in between the effective dates inclusive. any effective customer view: Customers of any effective date are returned from methods. The methods `useFederatedBusinessView()` and `useIsolatedBusinessView()` behave as a radio group and one should be selected before invoking any lookup methods. Customers may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Customer.`
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	canLookupCustomers
Description	Tests if this user can perform `Customer` 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	useComparativeCustomerView
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	usePlenaryCustomerView
Description	A complete view of the `Customer` 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 customers 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	useEffectiveCustomerView
Description	Only customers whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveCustomerView
Description	All customers of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCustomer
Description	Gets the `Customer` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Customer` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Customer` and retained for compatibility. In effective mode, customers are returned that are currently effective. In any effective mode, effective customers and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	the `Id` of the `Customer` to retrieve
Return	`osid.billing.Customer`		the returned `Customer`
Errors	NOT_FOUND		no `Customer` found with the given `Id`
	NULL_ARGUMENT		`customerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCustomersByIds
Description	Gets a `CustomerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the customers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Customers` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, customers are returned that are currently effective. In any effective mode, effective customers and those currently expired are returned.
Parameters	`osid.id.IdList`	`customerIds`	the list of `Ids` to retrieve
Return	`osid.billing.CustomerList`		the returned `CustomerList` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`customerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCustomersByGenusType
Description	Gets a `CustomerList` corresponding to the given customer genus `Type` which does not include customers of types derived from the specified `Type.` In plenary mode, the returned list contains all known customers or an error results. Otherwise, the returned list may contain only those customers that are accessible through this session. In effective mode, customers are returned that are currently effective. In any effective mode, effective customers and those currently expired are returned.
Parameters	`osid.type.Type`	`customerGenusType`	a customer genus type
Return	`osid.billing.CustomerList`		the returned `CustomerList` list
Errors	NULL_ARGUMENT		`customerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCustomersByParentGenusType
Description	Gets a `CustomerList` corresponding to the given customer genus `Type` and include any additional customers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known customers or an error results. Otherwise, the returned list may contain only those customers that are accessible through this session. In effective mode, customers are returned that are currently effective. In any effective mode, effective customers and those currently expired are returned.
Parameters	`osid.type.Type`	`customerGenusType`	a customer genus type
Return	`osid.billing.CustomerList`		the returned `CustomerList` list
Errors	NULL_ARGUMENT		`customerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCustomersByRecordType
Description	Gets a `CustomerList` containing the given customer record `Type.` In plenary mode, the returned list contains all known customers or an error results. Otherwise, the returned list may contain only those customers that are accessible through this session. In effective mode, customers are returned that are currently effective. In any effective mode, effective customers and those currently expired are returned.
Parameters	`osid.type.Type`	`customerRecordType`	a customer record type
Return	`osid.billing.CustomerList`		the returned `CustomerList` list
Errors	NULL_ARGUMENT		`customerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCustomersOnDate
Description	Gets a `CustomerList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known customers or an error results. Otherwise, the returned list may contain only those customers that are accessible through this session. In effective mode, customers are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective customers and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.billing.CustomerList`		the returned `CustomerList` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCustomersByNumber
Description	Gets a `CustomerList` related to the given customer number. In plenary mode, the returned list contains all known customers or an error results. Otherwise, the returned list may contain only those customers that are accessible through this session. In effective mode, customers are returned that are currently effective. In any effective mode, effective customers and those currently expired are returned.
Parameters	`string`	`number`	a customer number
Return	`osid.billing.CustomerList`		the returned `CustomerList` list
Errors	NULL_ARGUMENT		`number` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCustomersByResource
Description	Gets a `CustomerList` related to the given resource `.` In plenary mode, the returned list contains all known customers or an error results. Otherwise, the returned list may contain only those customers that are accessible through this session. In effective mode, customers are returned that are currently effective. In any effective mode, effective customers and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.billing.CustomerList`		the returned `CustomerList` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCustomersByResourceOnDate
Description	Gets a `CustomerList` of the given resource and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known customers or an error results. Otherwise, the returned list may contain only those customers that are accessible through this session. In effective mode, customers are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective customers and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.billing.CustomerList`		the returned `CustomerList` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCustomersByActivity
Description	Gets a `CustomerList` having the given activity. In plenary mode, the returned list contains all known customers or an error results. Otherwise, the returned list may contain only those customers that are accessible through this session. In effective mode, customers are returned that are currently effective. In any effective mode, effective customers and those currently expired are returned.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Return	`osid.billing.CustomerList`		the returned `CustomerList` list
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCustomers
Description	Gets all `Customers.` In plenary mode, the returned list contains all known customers or an error results. Otherwise, the returned list may contain only those customers that are accessible through this session.
Return	`osid.billing.CustomerList`		a list of `Customers`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.