org.osid.resource.demographic

Interface DemographicBinSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface DemographicBinSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupDemographicBinMappings() Tests if this user can perform lookups of demographic/bin mappings.
IdList	getBinIdsByDemographic(Id demographicId) Gets the Bin Ids mapped to a Demographic.
BinList	getBinsByDemographic(Id demographicId) Gets the Bins mapped to a Demographic.
IdList	getDemographicIdsByBin(Id binId) Gets the list of DemographicIds associated with an Bin.
IdList	getDemographicIdsByBins(IdList binIds) Gets the list of Demographic Ids corresponding to a list of Bins.
DemographicList	getDemographicsByBin(Id binId) Gets the list of demographics associated with an Bin.
DemographicList	getDemographicsByBins(IdList binIds) Gets the list of demographic corresponding to a list of Bins.
void	useComparativeDemographicBinView() 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	usePlenaryDemographicBinView() A complete view of the Demographic and Bin returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupDemographicBinMappings

boolean canLookupDemographicBinMappings()

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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeDemographicBinView

void useComparativeDemographicBinView()

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.

usePlenaryDemographicBinView

void usePlenaryDemographicBinView()

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.

Compliance:

mandatory - This method is must be implemented.

getDemographicIdsByBin

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

Gets the list of DemographicIds associated with an Bin.

Parameters:

binId - Id of the Bin

Returns:

list of related demographic 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.

getDemographicsByBin

DemographicList getDemographicsByBin(Id binId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets the list of demographics associated with an Bin.

Parameters:

binId - Id of the Bin

Returns:

list of related demographics

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.

getDemographicIdsByBins

IdList getDemographicIdsByBins(IdList binIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

binIds - list of bin Ids

Returns:

list of demographic Ids

Throws:

NullArgumentException - binIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDemographicsByBins

DemographicList getDemographicsByBins(IdList binIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

binIds - list of bin Ids

Returns:

list of demographics

Throws:

NullArgumentException - binIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBinIdsByDemographic

IdList getBinIdsByDemographic(Id demographicId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Gets the Bin Ids mapped to a Demographic.

Parameters:

demographicId - Id of a Demographic

Returns:

list of bins

Throws:

NotFoundException - demographicId is not found

NullArgumentException - demographicId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBinsByDemographic

BinList getBinsByDemographic(Id demographicId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the Bins mapped to a Demographic.

Parameters:

demographicId - Id of a Demographic

Returns:

list of bins

Throws:

NotFoundException - demographicId is not found

NullArgumentException - demographicId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.