Interface | osid.resource.demographic.DemographicBinSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupDemographicBinMappings | ||
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 | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeDemographicBinView | ||
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 | usePlenaryDemographicBinView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getDemographicIdsByBin | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | binId | Id of the Bin |
Return | osid.id.IdList | list of related demographic Ids | |
Errors | NOT_FOUND | binId is not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicsByBin | ||
Description |
Gets the list of demographics associated with an | ||
Parameters | osid.id.Id | binId | Id of the Bin |
Return | osid.resource.demographic.DemographicList | list of related demographics | |
Errors | NOT_FOUND | binId is not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicIdsByBins | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | binIds | list of bin Ids |
Return | osid.id.IdList | list of demographic Ids | |
Errors | NULL_ARGUMENT | binIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicsByBins | ||
Description |
Gets the list of demographic corresponding to a list of
| ||
Parameters | osid.id.IdList | binIds | list of bin Ids |
Return | osid.resource.demographic.DemographicList | list of demographics | |
Errors | NULL_ARGUMENT | binIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBinIdsByDemographic | ||
Description |
Gets the | ||
Parameters | osid.id.Id | demographicId | Id of a Demographic |
Return | osid.id.IdList | list of bins | |
Errors | NOT_FOUND | demographicId is not found | |
NULL_ARGUMENT | demographicId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBinsByDemographic | ||
Description |
Gets the | ||
Parameters | osid.id.Id | demographicId | Id of a Demographic |
Return | osid.resource.BinList | list of bins | |
Errors | NOT_FOUND | demographicId is not found | |
NULL_ARGUMENT | demographicId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |