Interface DemographicEnablerBinSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	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 DemographicEnablerIds 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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupDemographicEnablerBinMappings

boolean canLookupDemographicEnablerBinMappings()

Tests if this user can perform lookups of demographic enabler/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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeDemographicEnablerBinView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryDemographicEnablerBinView

void usePlenaryDemographicEnablerBinView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getDemographicEnablerIdsByBin

IdList getDemographicEnablerIdsByBin(Id binId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of DemographicEnablerIds associated with an Bin .

Parameters:

binId - Id of the Bin

Returns:

list of related demographic enabler Ids

Throws:

NotFoundException - binId is not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDemographicEnablersByBin

DemographicEnablerList getDemographicEnablersByBin(Id binId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of demographic enablers associated with an Bin .

Parameters:

binId - Id of the Bin

Returns:

list of related demographic enablers

Throws:

NotFoundException - binId is not found

NullArgumentException - binId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDemographicEnablerIdsByBins

IdList getDemographicEnablerIdsByBins(IdList binIds)
                               throws OperationFailedException,
PermissionDeniedException

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

Parameters:

binIds - list of bin Ids

Returns:

list of demographic enabler Ids

Throws:

NullArgumentException - binIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDemographicEnablersByBins

DemographicEnablerList getDemographicEnablersByBins(IdList binIds)
                                             throws OperationFailedException,
PermissionDeniedException

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

Parameters:

binIds - list of bin Ids

Returns:

list of demographic enablers

Throws:

NullArgumentException - binIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBinIdsByDemographicEnabler

IdList getBinIdsByDemographicEnabler(Id demographicEnablerId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Bin Ids mapped to a DemographicEnabler .

Parameters:

demographicEnablerId - Id of a DemographicEnabler

Returns:

list of bins

Throws:

NotFoundException - demographicEnablerId is not found

NullArgumentException - demographicEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBinsByDemographicEnabler

BinList getBinsByDemographicEnabler(Id demographicEnablerId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Bins mapped to a DemographicEnabler .

Parameters:

demographicEnablerId - Id of a DemographicEnabler

Returns:

list of bins

Throws:

NotFoundException - demographicEnablerId is not found

NullArgumentException - demographicEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.