public interface DemographicEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve DemographicEnabler
to Demographic
mappings. A Demographic
with multiple DemographicEnablers
means any
positive rule evaluation across the enablers result in an effective
Demographic.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupDemographicEnablerRules()
Tests if this user can perform lookups of demographic
enabler/demographic mappings.
|
Bin |
getBin()
Gets the
Bin associated with this session. |
Id |
getBinId()
Gets the
Bin Id associated with this
session. |
IdList |
getDemographicEnablerIdsForDemographic(Id demographicId)
Gets the
DemographicEnabler Id associated with a
Demographic. |
DemographicEnablerList |
getDemographicEnablersForDemographic(Id demographicId)
Gets the
DemographicEnabler associated with a
Demographic. |
IdList |
getDemographicIdsForDemographicEnabler(Id demographicEnablerId)
Gets the
Demographic Ids mapped to a
DemographicEnabler. |
DemographicList |
getDemographicsForDemographicEnabler(Id demographicEnablerId)
Gets the
Demographics mapped to a
DemographicEnabler. |
void |
useComparativeDemographicEnablerRuleView()
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 |
useFederatedBinView()
Federates the view for methods in this session.
|
void |
useIsolatedBinView()
Isolates the view for methods in this session.
|
void |
usePlenaryDemographicEnablerRuleView()
A complete view of the
DemographicEnabler and
Demographic returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBinId()
Bin
Id
associated with this
session. Bin Id
associated with this sessionmandatory
- This method must be implemented. Bin getBin() throws OperationFailedException, PermissionDeniedException
Bin
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupDemographicEnablerRules()
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 useComparativeDemographicEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryDemographicEnablerRuleView()
DemographicEnabler
and
Demographic
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. void useFederatedBinView()
mandatory
- This method is must be implemented. void useIsolatedBinView()
mandatory
- This method is must be implemented. IdList getDemographicEnablerIdsForDemographic(Id demographicId) throws NotFoundException, OperationFailedException, PermissionDeniedException
DemographicEnabler Id
associated with a
Demographic.
demographicId
- Id
of the Demographic
Ids
NotFoundException
- demographicId
is not
foundNullArgumentException
- demographicId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DemographicEnablerList getDemographicEnablersForDemographic(Id demographicId) throws NotFoundException, OperationFailedException, PermissionDeniedException
DemographicEnabler
associated with a
Demographic.
demographicId
- Id
of the Demographic
NotFoundException
- demographicId
is not
foundNullArgumentException
- demographicId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDemographicIdsForDemographicEnabler(Id demographicEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Demographic
Ids
mapped to a
DemographicEnabler.
demographicEnablerId
- Id
of a
DemographicEnabler
Ids
NotFoundException
- demographicEnablerId
is not foundNullArgumentException
- demographicEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DemographicList getDemographicsForDemographicEnabler(Id demographicEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Demographics
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.