Interface HoldOublietteSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface HoldOublietteSession
extends OsidSession

This session provides methods to retrieve Hold to Oubliette mappings. A Hold 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	canLookupHoldOublietteMappings()	Tests if this user can perform lookups of hold/oubliette mappings.
IdList	getHoldIdsByOubliette(Id oublietteId)	Gets the list of Hold Ids associated with an Oubliette .
IdList	getHoldIdsByOubliettes(IdList oublietteIds)	Gets the list of Hold Ids corresponding to a list of Oubliettes .
HoldList	getHoldsByOubliette(Id oublietteId)	Gets the list of Holds associated with an Oubliette .
HoldList	getHoldsByOubliettes(IdList oublietteIds)	Gets the list of Hold corresponding to a list of Oubliettes .
OublietteList	getOublietteByHold(Id holdId)	Gets the Oubliettes mapped to a Hold .
IdList	getOublietteIdsByHold(Id holdId)	Gets the Oubliette Ids mapped to a Hold .
void	useComparativeHoldOublietteView()	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	usePlenaryHoldOublietteView()	A complete view of the Hold 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

canLookupHoldOublietteMappings

boolean canLookupHoldOublietteMappings()

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

useComparativeHoldOublietteView

void useComparativeHoldOublietteView()

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.

usePlenaryHoldOublietteView

void usePlenaryHoldOublietteView()

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

getHoldIdsByOubliette

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

Gets the list of Hold Ids associated with an Oubliette .

Parameters:

oublietteId - Id of the Oubliette

Returns:

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

getHoldsByOubliette

HoldList getHoldsByOubliette(Id oublietteId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Holds associated with an Oubliette .

Parameters:

oublietteId - Id of the Oubliette

Returns:

list of related holds

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.

getHoldIdsByOubliettes

IdList getHoldIdsByOubliettes(IdList oublietteIds)
                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

oublietteIds - list of oubliette Ids

Returns:

list of hold Ids

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHoldsByOubliettes

HoldList getHoldsByOubliettes(IdList oublietteIds)
                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

oublietteIds - list of oubliette Ids

Returns:

list of holds

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOublietteIdsByHold

IdList getOublietteIdsByHold(Id holdId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Oubliette Ids mapped to a Hold .

Parameters:

holdId - Id of a Hold

Returns:

list of oubliettes

Throws:

NotFoundException - holdId is not found

NullArgumentException - holdId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOublietteByHold

OublietteList getOublietteByHold(Id holdId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Oubliettes mapped to a Hold .

Parameters:

holdId - Id of a Hold

Returns:

list of oubliettes

Throws:

NotFoundException - holdId is not found

NullArgumentException - holdId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.