Interface BlockOublietteSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BlockOublietteSession
extends OsidSession

This session provides methods to retrieve Block to Oubliette holds. A Block may appear in multiple Oubliette objects. Each oubliette 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	canLookupBlockOublietteMappings()	Tests if this user can perform lookups of block/oubliette holds.
IdList	getBlockIdsByOubliette(Id oublietteId)	Gets the list of Block Ids associated with an Oubliette .
IdList	getBlockIdsByOubliettes(IdList oublietteIds)	Gets the list of Block Ids corresponding to a list of Oubliettes .
BlockList	getBlocksByOubliette(Id oublietteId)	Gets the list of Blocks associated with an Oubliette .
BlockList	getBlocksByOubliettes(IdList oublietteIds)	Gets the list of Block corresponding to a list of Oubliettes .
IdList	getOublietteIdsByBlock(Id blockId)	Gets the Oubliette Ids mapped to a Block .
OublietteList	getOubliettesByBlock(Id blockId)	Gets the Oubliettes mapped to a Block .
void	useComparativeBlockOublietteView()	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	usePlenaryBlockOublietteView()	A complete view of the Block and Oubliette 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

canLookupBlockOublietteMappings

boolean canLookupBlockOublietteMappings()

Tests if this user can perform lookups of block/oubliette holds. 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.

useComparativeBlockOublietteView

void useComparativeBlockOublietteView()

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.

usePlenaryBlockOublietteView

void usePlenaryBlockOublietteView()

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

getBlockIdsByOubliette

IdList getBlockIdsByOubliette(Id oublietteId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Block Ids associated with an Oubliette .

Parameters:

oublietteId - Id of the Oubliette

Returns:

list of related block Ids

Throws:

NotFoundException - oublietteId is not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBlocksByOubliette

BlockList getBlocksByOubliette(Id oublietteId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Blocks associated with an Oubliette .

Parameters:

oublietteId - Id of the Oubliette

Returns:

list of related blocks

Throws:

NotFoundException - oublietteId is not found

NullArgumentException - oublietteId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBlockIdsByOubliettes

IdList getBlockIdsByOubliettes(IdList oublietteIds)
                        throws OperationFailedException,
PermissionDeniedException

Gets the list of Block Ids corresponding to a list of Oubliettes .

Parameters:

oublietteIds - list of oubliette Ids

Returns:

list of block Ids

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBlocksByOubliettes

BlockList getBlocksByOubliettes(IdList oublietteIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of Block corresponding to a list of Oubliettes .

Parameters:

oublietteIds - list of oubliette Ids

Returns:

list of blocks

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOublietteIdsByBlock

IdList getOublietteIdsByBlock(Id blockId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Oubliette Ids mapped to a Block .

Parameters:

blockId - Id of a Block

Returns:

list of oubliettes

Throws:

NotFoundException - blockId is not found

NullArgumentException - blockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOubliettesByBlock

OublietteList getOubliettesByBlock(Id blockId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Oubliettes mapped to a Block .

Parameters:

blockId - Id of a Block

Returns:

list of oubliettes

Throws:

NotFoundException - blockId is not found

NullArgumentException - blockId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.