OSID Logo
OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.demographic.DemographicBinSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Demographic to Bin mappings. A Demographic may appear in multiple Bin objects. Each bin 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
MethodcanLookupDemographicBinMappings
Description

Tests if this user can perform lookups of demographic/bin 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.
MethoduseComparativeDemographicBinView
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.
MethodusePlenaryDemographicBinView
Description

A complete view of the Demographic and Bin 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.
MethodgetDemographicIdsByBin
Description

Gets the list of DemographicIds associated with an Bin.

Parametersosid.id.IdbinId Id of the Bin
Returnosid.id.IdListlist of related demographic Ids
ErrorsNOT_FOUND binId is not found
NULL_ARGUMENT binId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDemographicsByBin
Description

Gets the list of demographics associated with an Bin.

Parametersosid.id.IdbinId Id of the Bin
Returnosid.resource.demographic.DemographicListlist of related demographics
ErrorsNOT_FOUND binId is not found
NULL_ARGUMENT binId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDemographicIdsByBins
Description

Gets the list of Demographic Ids corresponding to a list of Bins.

Parametersosid.id.IdListbinIdslist of bin Ids
Returnosid.id.IdListlist of demographic Ids
ErrorsNULL_ARGUMENT binIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDemographicsByBins
Description

Gets the list of demographic corresponding to a list of Bins.

Parametersosid.id.IdListbinIdslist of bin Ids
Returnosid.resource.demographic.DemographicListlist of demographics
ErrorsNULL_ARGUMENT binIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBinIdsByDemographic
Description

Gets the Bin Ids mapped to a Demographic.

Parametersosid.id.IddemographicId Id of a Demographic
Returnosid.id.IdListlist of bins
ErrorsNOT_FOUND demographicId is not found
NULL_ARGUMENT demographicId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBinsByDemographic
Description

Gets the Bins mapped to a Demographic.

Parametersosid.id.IddemographicId Id of a Demographic
Returnosid.resource.BinListlist of bins
ErrorsNOT_FOUND demographicId is not found
NULL_ARGUMENT demographicId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.