OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.PeriodBusinessSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Period to Business mappings. A Period may appear in multiple Business objects. Each catalog may have its own authorizations governing who is allowed to look at it.

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

Tests if this user can perform lookups of period/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativePeriodBusinessView
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.
MethodusePlenaryPeriodCatalogView
Description

A complete view of the Period and Business 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.
MethodgetPeriodIdsByBusiness
Description

Gets the list of Period Ids associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.id.IdListlist of related period Ids
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPeriodsByBusiness
Description

Gets the list of Period associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.billing.PeriodListlist of related periods
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPeriodIdsByBusinesses
Description

Gets the list of Period Ids corresponding to a list of Business objects.

Parametersosid.id.IdListbusinessIdslist of catalog Ids
Returnosid.id.IdListlist of period Ids
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPeriodsByBusinesses
Description

Gets the list of Periods corresponding to a list of Business objects.

Parametersosid.id.IdListbusinessIdslist of catalog Ids
Returnosid.billing.PeriodListlist of periods
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessIdsByPeriod
Description

Gets the Business Ids mapped to a Period.

Parametersosid.id.IdperiodId Id of a Period
Returnosid.id.IdListlist of businesses
ErrorsNOT_FOUND periodId is not found
NULL_ARGUMENT periodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesByPeriod
Description

Gets the Business objects mapped to a Period.

Parametersosid.id.IdperiodId Id of a Period
Returnosid.billing.BusinessListlist of businesses
ErrorsNOT_FOUND periodId is not found
NULL_ARGUMENT periodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.