OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.BillingLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Billing objects. The Billing represents a collection of Credits.

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
MethodcanLookupBillings
Description

Tests if this user can perform Billing 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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBillingView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBillingView
Description

A complete view of the Billing 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.

CompliancemandatoryThis method is must be implemented.
MethodgetBilling
Description

Gets the Billing specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Billing may have a different Id than requested, such as the case where a duplicate Id was assigned to a Billing and retained for compatibility.

Parametersosid.id.IdbillingId Id of the Billing
Returnosid.acknowledgement.Billingthe billing
ErrorsNOT_FOUND billingId not found
NULL_ARGUMENT billingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetBillingsByIds
Description

Gets a BillingList corresponding to the given IdList. In plenary mode, the returned list contains all of the billings 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 Billings may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListbillingIdsthe list of Ids to retrieve
Returnosid.acknowledgement.BillingListthe returned Billing list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT billingIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBillingsByGenusType
Description

Gets a BillingList corresponding to the given billing genus Type which does not include billings of genus types derived from the specified Type. In plenary mode, the returned list contains all known billings or an error results. Otherwise, the returned list may contain only those billings that are accessible through this session.

Parametersosid.type.TypebillingGenusTypea billing genus type
Returnosid.acknowledgement.BillingListthe returned Billing list
ErrorsNULL_ARGUMENT billingGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBillingsByParentGenusType
Description

Gets a BillingList corresponding to the given billing genus Type and include any additional billings with genus types derived from the specified Type. In plenary mode, the returned list contains all known billings or an error results. Otherwise, the returned list may contain only those billings that are accessible through this session.

Parametersosid.type.TypebillingGenusTypea billing genus type
Returnosid.acknowledgement.BillingListthe returned Billing list
ErrorsNULL_ARGUMENT billingGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBillingsByRecordType
Description

Gets a BillingList containing the given billing record Type. In plenary mode, the returned list contains all known billings or an error results. Otherwise, the returned list may contain only those billings that are accessible through this session.

Parametersosid.type.TypebillingRecordTypea billing record type
Returnosid.acknowledgement.BillingListthe returned Billing list
ErrorsNULL_ARGUMENT billingRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBillingsByProvider
Description

Gets a BillingList from the given Provider. In plenary mode, the returned list contains all known billings or an error results. Otherwise, the returned list may contain only those billings that are accessible through this session.

Parametersosid.id.IdproviderIda provider Id
Returnosid.acknowledgement.BillingListthe returned Billing list
ErrorsNULL_ARGUMENT providerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBillings
Description

Gets all Billings. In plenary mode, the returned list contains all known billings or an error results. Otherwise, the returned list may contain only those billings that are accessible through this session.

Returnosid.acknowledgement.BillingLista list of Billings
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.