OSID - osid.billing.EntryLookupSession Service Interface Definition

Interface	osid.billing.EntryLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Entry` objects. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated business view: All entry methods in this session operate, retrieve and pertain to entries defined explicitly in the current business. Using an isolated view is useful for managing `Entries` with the `EntryAdminSession.` federated business view: All entry methods in this session operate, retrieve and pertain to all entries defined in this business and any other entries implicitly available in this business through business inheritence. effective entry view: All entry lookup methods return entries where the current date falls in between the effective dates inclusive. any effective entry view: Entries of any effective date are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedBusinessView()` and `useIsolatedBusinessView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupEntries
Description	Tests if this user can perform `Entry` 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 opt not to 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	useComparativeEntryView
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	usePlenaryEntryView
Description	A complete view of the `Entry` 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 entries in businesses which are children of this business 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 lookups to this business only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveEntryView
Description	Only entries whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveEntryView
Description	All entries of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getEntry
Description	Gets the `Entry` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Entry` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Entry` and retained for compatibility. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`entryId`	`Id` of the `Entry`
Return	`osid.billing.Entry`		the entry
Errors	NOT_FOUND		`entryId` not found
	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getEntriesByIds
Description	Gets an `EntryList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the entries 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 `Entries` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.IdList`	`entryIds`	the list of `Ids` to retrieve
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`entryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByGenusType
Description	Gets an `EntryList` corresponding to the given entry genus `Type` which does not include entries of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.type.Type`	`entryGenusType`	an entry genus type
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`entryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByParentGenusType
Description	Gets an `EntryList` corresponding to the given entry genus `Type` and include any additional entries with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.type.Type`	`entryGenusType`	an entry genus type
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`entryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByRecordType
Description	Gets an `EntryList` containing the given entry record `Type.` In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.type.Type`	`entryRecordType`	an entry record type
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByPeriod
Description	Gets an `EntryList` in the given billing period. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`periodId`	a billing period `Id`
Return	`osid.billing.EntryList`		the returned `Entry` 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	getEntriesOnDate
Description	Gets an `EntryList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.billing.EntryList`		the returned `Entry` 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	getEntriesForCustomer
Description	Gets an `EntryList` for the given customer. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Return	`osid.billing.EntryList`		the returned `Entry` 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	getEntriesForCustomerOnDate
Description	Gets an `EntryList` for the given customer 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 entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`customerId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByPeriodForCustomer
Description	Gets an `EntryList` for the given customer in a billing period. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Parameters	`osid.id.Id`	`periodId`	a billing period `Id`
Return	`osid.billing.EntryList`		the returned `Entry` 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	getEntriesByPeriodForCustomerOnDate
Description	Gets an `EntryList` in the given billing period for the given customer 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 entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
	`osid.id.Id`	`periodId`	a billing period `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`customerId, periodId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesForItem
Description	Gets an `EntryList` for the given item. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`itemId`	an item `Id`
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`itemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesForItemOnDate
Description	Gets an `EntryList` for the given item 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 entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`itemId`	an item `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`itemId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByPeriodForItem
Description	Gets an `EntryList` for the given item in a billing period. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`itemId`	an item `Id`
Parameters	`osid.id.Id`	`periodId`	a billing period `Id`
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`itemId` or `periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByPeriodForItemOnDate
Description	Gets an `EntryList` in the given billing period for the given item 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 entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`itemId`	an item `Id`
	`osid.id.Id`	`periodId`	a billing period `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`itemId, periodId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesForCustomerAndItem
Description	Gets an `EntryList` for the given customer and item. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
Parameters	`osid.id.Id`	`itemId`	an item `Id`
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`customerId` or `itemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesForCustomerAndItemOnDate
Description	Gets an `EntryList` for the given customer and item 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 entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
	`osid.id.Id`	`itemId`	an item `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`customerId, itemId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByPeriodForCustomerAndItem
Description	Gets an `EntryList` for the given customer and item in a billing period. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
	`osid.id.Id`	`itemId`	an item `Id`
	`osid.id.Id`	`periodId`	a period `Id`
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`customerId, itemId,` or `periodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByPeriodForCustomerAndItemOnDate
Description	Gets an `EntryList` for the given customer and item in a billing period 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 entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective entries and those currently expired are returned.
Parameters	`osid.id.Id`	`customerId`	a customer `Id`
	`osid.id.Id`	`itemId`	an item `Id`
	`osid.id.Id`	`periodId`	a period `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.billing.EntryList`		the returned `Entry` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`customerId, itemId, periodId, from, or to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntries
Description	Gets all `Entries.` In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. In effective mode, entries are returned that are currently effective. In any effective mode, effective entries and those currently expired are returned.
Return	`osid.billing.EntryList`		a list of `Entries`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.