Interface HoldEnablerOublietteSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface HoldEnablerOublietteSession
extends OsidSession

This session provides methods to retrieve HoldEnabler to Hold mappings. A HoldEnabler may appear in multiple Hold objects. Each hold 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	canLookupHoldEnablerOubliettetMappings()	Tests if this user can perform lookups of hold enabler/oubliette mappings.
IdList	getHoldEnablerIdsByOubliette(Id oublietteId)	Gets the list of HoldEnablerIds associated with a Oubliette .
IdList	getHoldEnablerIdsByOubliettes(IdList oublietteIds)	Gets the list of HoldEnabler Ids corresponding to a list of Oubliettes .
HoldEnablerList	getHoldEnablersByOubliette(Id oublietteId)	Gets the list of hold enablers associated with a Oubliette .
HoldEnablerList	getHoldEnablersByOubliettes(IdList oublietteIds)	Gets the list of hold enablers corresponding to a list of Oubliettes .
OublietteList	getHoldsByHoldEnabler(Id holdEnablerId)	Gets the oubliettes mapped to a HoldEnabler .
IdList	getOublietteIdsByHoldEnabler(Id holdEnablerId)	Gets the Oubliette Ids mapped to a HoldEnabler .
void	useComparativeHoldEnablerOublietteView()	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	usePlenaryHoldEnablerOublietteView()	A complete view of the HoldEnabler 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

canLookupHoldEnablerOubliettetMappings

boolean canLookupHoldEnablerOubliettetMappings()

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

useComparativeHoldEnablerOublietteView

void useComparativeHoldEnablerOublietteView()

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.

usePlenaryHoldEnablerOublietteView

void usePlenaryHoldEnablerOublietteView()

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

getHoldEnablerIdsByOubliette

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

Gets the list of HoldEnablerIds associated with a Oubliette .

Parameters:

oublietteId - Id of the Oubliette

Returns:

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

getHoldEnablersByOubliette

HoldEnablerList getHoldEnablersByOubliette(Id oublietteId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of hold enablers associated with a Oubliette .

Parameters:

oublietteId - Id of the Oubliette

Returns:

list of related hold enablers

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.

getHoldEnablerIdsByOubliettes

IdList getHoldEnablerIdsByOubliettes(IdList oublietteIds)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

oublietteIds - list of oubliette Ids

Returns:

list of hold enabler Ids

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHoldEnablersByOubliettes

HoldEnablerList getHoldEnablersByOubliettes(IdList oublietteIds)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the list of hold enablers corresponding to a list of Oubliettes .

Parameters:

oublietteIds - list of oubliette Ids

Returns:

list of hold enablers

Throws:

NullArgumentException - oublietteIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOublietteIdsByHoldEnabler

IdList getOublietteIdsByHoldEnabler(Id holdEnablerId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Oubliette Ids mapped to a HoldEnabler .

Parameters:

holdEnablerId - Id of a HoldEnabler

Returns:

list of oubliette Ids

Throws:

NotFoundException - holdEnablerId is not found

NullArgumentException - holdEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHoldsByHoldEnabler

OublietteList getHoldsByHoldEnabler(Id holdEnablerId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the oubliettes mapped to a HoldEnabler .

Parameters:

holdEnablerId - Id of a HoldEnabler

Returns:

list of oubliettes

Throws:

NotFoundException - holdEnablerId is not found

NullArgumentException - holdEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.