public interface DemographicEnablerBinSession extends OsidSession
This session provides methods to retrieve DemographicEnabler
to Bin
mappings. A DemographicEnabler
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:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupDemographicEnablerBinMappings()
Tests if this user can perform lookups of demographic enabler/bin
mappings.
|
IdList |
getBinIdsByDemographicEnabler(Id demographicEnablerId)
Gets the
Bin Ids mapped to a
DemographicEnabler. |
BinList |
getBinsByDemographicEnabler(Id demographicEnablerId)
Gets the
Bins mapped to a DemographicEnabler. |
IdList |
getDemographicEnablerIdsByBin(Id binId)
Gets the list of
DemographicEnablerIds associated with
an Bin. |
IdList |
getDemographicEnablerIdsByBins(IdList binIds)
Gets the list of
DemographicEnabler Ids corresponding
to a list of Bins. |
DemographicEnablerList |
getDemographicEnablersByBin(Id binId)
Gets the list of demographic enablers associated with an
Bin. |
DemographicEnablerList |
getDemographicEnablersByBins(IdList binIds)
Gets the list of demographic enablers corresponding to a list of
Bins. |
void |
useComparativeDemographicEnablerBinView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryDemographicEnablerBinView()
A complete view of the
DemographicEnabler and
Bin returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupDemographicEnablerBinMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeDemographicEnablerBinView()
mandatory
- This method is must be implemented. void usePlenaryDemographicEnablerBinView()
DemographicEnabler
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.mandatory
- This method is must be implemented. IdList getDemographicEnablerIdsByBin(Id binId) throws NotFoundException, OperationFailedException, PermissionDeniedException
DemographicEnablerIds
associated with
an Bin.
binId
- Id
of the Bin
Ids
NotFoundException
- binId
is not foundNullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DemographicEnablerList getDemographicEnablersByBin(Id binId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bin.
binId
- Id
of the Bin
NotFoundException
- binId
is not foundNullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDemographicEnablerIdsByBins(IdList binIds) throws OperationFailedException, PermissionDeniedException
DemographicEnabler Ids
corresponding
to a list of Bins.
binIds
- list of bin Ids
Ids
NullArgumentException
- binIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DemographicEnablerList getDemographicEnablersByBins(IdList binIds) throws OperationFailedException, PermissionDeniedException
Bins.
binIds
- list of bin Ids
NullArgumentException
- binIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBinIdsByDemographicEnabler(Id demographicEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bin
Ids
mapped to a
DemographicEnabler.
demographicEnablerId
- Id
of a
DemographicEnabler
NotFoundException
- demographicEnablerId
is not foundNullArgumentException
- demographicEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BinList getBinsByDemographicEnabler(Id demographicEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bins
mapped to a DemographicEnabler.
demographicEnablerId
- Id
of a
DemographicEnabler
NotFoundException
- demographicEnablerId
is not foundNullArgumentException
- demographicEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.