org.osid.resource.demographic

Interface DemographicQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

DemographicSearchSession

public interface DemographicQuerySession
extends OsidSession

This session provides methods for searching among Demographic objects. The search query is constructed using the DemographicQuery.

This session defines views that offer differing behaviors for searching.

• federated bin view: searches include demographic in bins of which this bin is an ancestor in the bin hierarchy
• isolated bin view: searches are restricted to demographic in this bin

Demographic may have a query record indicated by their respective record types. The query record is accessed via the DemographicQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchDemographics() Tests if this user can perform Demographic lookups.
Bin	getBin() Gets the Bin associated with this session.
Id	getBinId() Gets the Bin Id associated with this session.
DemographicQuery	getDemographicQuery() Gets a demographic query.
DemographicList	getDemographicsByQuery(DemographicQuery demographicQuery) Gets a list of Demographics matching the given demographic query.
void	useFederatedBinView() Federates the view for methods in this session.
void	useIsolatedBinView() Isolates the view for methods in this session.

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

getBinId

Id getBinId()

Gets the Bin Id associated with this session.

Returns:

the Bin Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBin

Bin getBin()
           throws OperationFailedException,
                  PermissionDeniedException

Gets the Bin associated with this session.

Returns:

the bin

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchDemographics

boolean canSearchDemographics()

Tests if this user can perform Demographic lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedBinView

void useFederatedBinView()

Federates the view for methods in this session. A federated view will include demographic in bins which are children of this broker in the bin hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBinView

void useIsolatedBinView()

Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.

Compliance:

mandatory - This method is must be implemented.

getDemographicQuery

DemographicQuery getDemographicQuery()

Gets a demographic query.

Returns:

the demographic query

Compliance:

mandatory - This method must be implemented.

getDemographicsByQuery

DemographicList getDemographicsByQuery(DemographicQuery demographicQuery)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a list of Demographics matching the given demographic query.

Parameters:

demographicQuery - the demographic query

Returns:

the returned DemographicList

Throws:

NullArgumentException - demographicQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - demographicQuery is not of this service

Compliance:

mandatory - This method must be implemented.