Interface DemographicBuilderSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DemographicBuilderSession
extends OsidSession

This session applies resource search queries and search orders to Demographics . Applying a search query to a demographic adds the resources resulting from that query to the demographic.

Method Summary

Modifier and Type	Method	Description
void	applyResourceQuery(Id demographicId, ResourceQuery resourceQuery)	Applies a resource query to a demographic.
void	applyResourceSequencing(Id demographicId, ResourceSearchOrder resourceSearchOrder)	Applies a demographic search order to this bin.
boolean	canBuildDemographics()	Tests if this user can build demographics.
void	clearResourceQuery(Id demographicId)	Clears the resource query effectively replacing it with a wildcard query.
void	clearResourceSequencing(Id demographicId)	Clears the resource sequencing.
Bin	getBin()	Gets the Bin associated with this session.
Id	getBinId()	Gets the Bin Id associated with this session.
ResourceQuery	getResourceQuery()	Gets a resource query.
ResourceQuery	getResourceQueryFromInspector(ResourceQueryInspector resourceQueryInspector)	Gets a resource query from an inspector.
ResourceSearchOrder	getResourceSearchOrder()	Gets a resource search order.
ResourceQueryInspector	inspectResourceQuery(Id demographicId)	Gets a resource query inspector for a demographic.

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

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.

canBuildDemographics

boolean canBuildDemographics()

Tests if this user can build demographics. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart bin management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

Gets a resource query.

Returns:

the resource query

Compliance:

mandatory - This method must be implemented.

getResourceSearchOrder

ResourceSearchOrder getResourceSearchOrder()

Gets a resource search order.

Returns:

the resource search order

Compliance:

mandatory - This method must be implemented.

applyResourceQuery

void applyResourceQuery(Id demographicId,
 ResourceQuery resourceQuery)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Applies a resource query to a demographic. If a query is already applied, it is replaced with the new one.

Parameters:

demographicId - a demographic Id

resourceQuery - the resource query

Throws:

NotFoundException - demographicId is not found

NullArgumentException - demographicId or resourceQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - resourceQuery did not originate from getResourceQuery()

Compliance:

mandatory - This method must be implemented.

inspectResourceQuery

ResourceQueryInspector inspectResourceQuery(Id demographicId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a resource query inspector for a demographic.

Parameters:

demographicId - a demographic Id

Returns:

the demographic query inspector

Throws:

NotFoundException - demographicId is not found

NullArgumentException - demographicId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

clearResourceQuery

void clearResourceQuery(Id demographicId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Clears the resource query effectively replacing it with a wildcard query.

Parameters:

demographicId - a demographic Id

Throws:

NotFoundException - demographicId is not found

NullArgumentException - demographicId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyResourceSequencing

void applyResourceSequencing(Id demographicId,
 ResourceSearchOrder resourceSearchOrder)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Applies a demographic search order to this bin.

Parameters:

demographicId - a demographic Id

resourceSearchOrder - the resource search order

Throws:

NotFoundException - demographicId is not found

NullArgumentException - demographicId or resourceSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - resourceSearchOrder did not originate from getResourceSearchOrder()

Compliance:

mandatory - This method must be implemented.

clearResourceSequencing

void clearResourceSequencing(Id demographicId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Clears the resource sequencing.

Parameters:

demographicId - a demographic Id

Throws:

NotFoundException - demographicId is not found

NullArgumentException - demographicId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getResourceQueryFromInspector

ResourceQuery getResourceQueryFromInspector(ResourceQueryInspector resourceQueryInspector)

Gets a resource query from an inspector.

Parameters:

resourceQueryInspector - a resource query inspector

Returns:

the resource query

Throws:

NullArgumentException - resourceQueryInspector is null

UnsupportedException - resourceQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.