OSID - osid.acknowledgement.CreditLookupSession Service Interface Definition

Interface	osid.acknowledgement.CreditLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving credits. 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 billing view: All credit methods in this session operate, retrieve and pertain to credits defined explicitly in the current billing. Using an isolated view is useful for managing credits with the `CreditAdminSession.` federated billing view: All credit lookup methods in this session operate, retrieve and pertain to all credits defined in this billing and any other billings implicitly available in this billing through billing inheritence. effective credit view: All credit lookup methods return credits where the current date falls in between the effective dates inclusive. any effective credit view: Credits of any effective date are returned from methods. The methods `useFederatedBillingView()` and `useIsolatedBillingView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getBillingId
Description	Gets the `Billing` `Id` associated with this session.
Return	`osid.id.Id`		the `Billing Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBilling
Description	Gets the `Billing` associated with this session.
Return	`osid.acknowledgement.Billing`		the billing
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupCredits
Description	Tests if this user can examine this billing. 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 these operations.
Return	`boolean`		`false` if billing reading methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCreditView
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	usePlenaryCreditView
Description	A complete view of the `Credit` 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	useFederatedBillingView
Description	Federates the view for methods in this session. A federated view will include credits in billings which are children of this billing in the billing hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBillingView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this billing only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveCreditView
Description	Only credits whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveCreditView
Description	All credits of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCredit
Description	Gets the `Credit` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Credit` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Credit` and retained for compatibility. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`creditId`	the `Id` of the `Credit` to retrieve
Return	`osid.acknowledgement.Credit`		the returned `Credit`
Errors	NOT_FOUND		no `Credit` found with the given `Id`
	NULL_ARGUMENT		`creditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsByIds
Description	Gets a `CreditList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the credits 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 credits may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.IdList`	`creditIds`	the list of `Ids` to retrieve
Return	`osid.acknowledgement.CreditList`		the returned `Credit list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`creditIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsByGenusType
Description	Gets a `CreditList` corresponding to the given credit genus `Type` which does not include credits of types derived from the specified `Type.` In plenary mode, the returned list contains all known credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.type.Type`	`creditGenusType`	a credits genus type
Return	`osid.acknowledgement.CreditList`		the returned `Credit list`
Errors	NULL_ARGUMENT		`creditGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsByParentGenusType
Description	Gets a `CreditList` corresponding to the given credit genus `Type` and include any additional credits with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.type.Type`	`creditGenusType`	a credit genus type
Return	`osid.acknowledgement.CreditList`		the returned `Credit list`
Errors	NULL_ARGUMENT		`creditGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsByRecordType
Description	Gets a `CreditList` containing the given credit record `Type.` In plenary mode, the returned list contains all known credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.type.Type`	`creditRecordType`	a credit record type
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	NULL_ARGUMENT		`creditRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsOnDate
Description	Gets a `CreditList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective credits 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.acknowledgement.CreditList`		the returned `CreditList`
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	getCreditsByGenusTypeOnDate
Description	Gets a list of credits of the given genus type and effective entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.type.Type`	`creditGenusType`	a credit genus `Type`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`creditGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsForResource
Description	Gets a `CreditList` for the given resource `Id.` In plenary mode, the returned list contains all of the credits corresponding to the given peer, including duplicates, or an error results if a credit is inaccessible. Otherwise, inaccessible `Credits` may be omitted from the list. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsForResourceOnDate
Description	Gets a list of credits for a 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 credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
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	getCreditsByGenusTypeForResource
Description	Gets a list of credits by a genus type for a resource. In plenary mode, the returned list contains all known credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.type.Type`	`creditGenusType`	a credit genus `Type`
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	NULL_ARGUMENT		`creditGenusType` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsByGenusTypeForResourceOnDate
Description	Gets a list of credits by genus type for a 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 credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`creditGenusType`	a credit genus `Type`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, creditGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsForReference
Description	Gets a `CreditList` for the given reference `Id.` In plenary mode, the returned list contains all of the credits corresponding to the given peer, including duplicates, or an error results if a credit is inaccessible. Otherwise, inaccessible `Credits` may be omitted from the list. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	NULL_ARGUMENT		`referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsForReferenceOnDate
Description	Gets a list of credits for a reference and effective entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`referenceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsByGenusTypeForReference
Description	Gets a list of credits by a genus type for a reference. In plenary mode, the returned list contains all known credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Parameters	`osid.type.Type`	`creditGenusType`	a credit genus `Type`
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	NULL_ARGUMENT		`referenceId` or `creditGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsByGenusTypeForReferenceOnDate
Description	Gets a list of credits of the given genus type for a reference and effective entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
	`osid.type.Type`	`creditGenusType`	a credit genus `Type`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`referenceId, creditGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsForResourceAndReference
Description	Gets a `CreditList` for the given resource and reference. In plenary mode, the returned list contains all of the credits corresponding to the given resource and reference, including duplicates, or an error results if a credit is inaccessible. Otherwise, inaccessible `Credits` may be omitted from the list. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`referenceId`	a reference `Id`
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	NULL_ARGUMENT		`resourceId` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsForResourceAndReferenceOnDate
Description	Gets a `CreditList` corresponding to the given resource and reference and effective entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all of the credits corresponding to the given peer, including duplicates, or an error results if a credit is inaccessible. Otherwise, inaccessible `Credits` may be omitted from the list. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`referenceId`	a reference `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsByGenusTypeForResourceAndReference
Description	Gets a `CreditList` of the given genus type for the given resource and reference. In plenary mode, the returned list contains all of the credits corresponding to the given resource and reference, including duplicates, or an error results if a credit is inaccessible. Otherwise, inaccessible `Credits` may be omitted from the list. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`referenceId`	a reference `Id`
	`osid.type.Type`	`creditGenusType`	a credit genus `Type`
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	NULL_ARGUMENT		`resourceId,` `referenceId,` or `creditGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsByGenusTypeForResourceAndReferenceOnDate
Description	Gets a `CreditList` of the given genus type corresponding to the given resource and reference and effective entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all of the credits corresponding to the given peer, including duplicates, or an error results if a credit is inaccessible. Otherwise, inaccessible `Credits` may be omitted from the list. In effective mode, credits are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`referenceId`	a reference `Id`
	`osid.type.Type`	`creditGenusType`	a credit genus `Type`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.acknowledgement.CreditList`		the returned `CreditList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, referenceId,` `creditGenusType,` `from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCredits
Description	Gets all credits. In plenary mode, the returned list contains all known credits or an error results. Otherwise, the returned list may contain only those credits that are accessible through this session. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Return	`osid.acknowledgement.CreditList`		a list of credits
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.