Interface EntryDictionarySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EntryDictionarySession
extends OsidSession

This session provides methods to retrieve Entry to Dictionary mappings. An Entry may appear in multiple dictionaries. Each Dictionary 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	canLookupEntryDictionaryMappings()	Tests if this user can perform lookups of entry/dictionary mappings.
DictionaryList	getDictionariesByEntry(Id entryId)	Gets the list of Dictionary objects mapped to an Entry .
IdList	getDictionaryIdsByEntry(Id entryId)	Gets the list of Dictionary Ids mapped to an Entry .
EntryList	getEntriesByDictionaries(IdList dictionaryIds)	Gets the list of entries corresponding to a list of dictioanries.
EntryList	getEntriesByDictionary(Id dictionaryId)	Gets the list of dictionary entries associated with a Dictionary .
IdList	getEntryIdsByDictionaries(IdList dictionaryIds)	Gets the list of Entry Ids corresponding to a list of Dictionary objects.
IdList	getEntryIdsByDictionary(Id dictionaryId)	Gets the list of Entry Ids associated with a Dictionary .
void	useComparativeDictionaryView()	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	usePlenaryDictionaryView()	A complete view of the Entry and Dictionary 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

useComparativeDictionaryView

void useComparativeDictionaryView()

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.

usePlenaryDictionaryView

void usePlenaryDictionaryView()

A complete view of the Entry and Dictionary 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.

canLookupEntryDictionaryMappings

boolean canLookupEntryDictionaryMappings()

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

getEntryIdsByDictionary

IdList getEntryIdsByDictionary(Id dictionaryId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Entry Ids associated with a Dictionary .

Parameters:

dictionaryId - Id of a Dictionary

Returns:

list of related entry Ids

Throws:

NotFoundException - dictionaryId is not found

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByDictionary

EntryList getEntriesByDictionary(Id dictionaryId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of dictionary entries associated with a Dictionary .

Parameters:

dictionaryId - Id of a Dictionary

Returns:

list of related entries

Throws:

NotFoundException - dictionaryId is not found

NullArgumentException - dictionaryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntryIdsByDictionaries

IdList getEntryIdsByDictionaries(IdList dictionaryIds)
                          throws OperationFailedException,
PermissionDeniedException

Gets the list of Entry Ids corresponding to a list of Dictionary objects.

Parameters:

dictionaryIds - list of dictionary Ids

Returns:

list of entry Ids

Throws:

NullArgumentException - dictionaryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByDictionaries

EntryList getEntriesByDictionaries(IdList dictionaryIds)
                            throws OperationFailedException,
PermissionDeniedException

Gets the list of entries corresponding to a list of dictioanries.

Parameters:

dictionaryIds - list of dictionary Ids

Returns:

list of entries

Throws:

NullArgumentException - dictionaryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDictionaryIdsByEntry

IdList getDictionaryIdsByEntry(Id entryId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Dictionary Ids mapped to an Entry .

Parameters:

entryId - Id of an Entry

Returns:

list of dictionary Ids

Throws:

NotFoundException - entryId is not found

NullArgumentException - entryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDictionariesByEntry

DictionaryList getDictionariesByEntry(Id entryId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Dictionary objects mapped to an Entry .

Parameters:

entryId - Id of an Entry

Returns:

list of dictionaries

Throws:

NotFoundException - entryId is not found

NullArgumentException - entryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.