org.osid.dictionary

Interface DictionaryQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

DictionarySearchSession

public interface DictionaryQuerySession
extends OsidSession

This session provides methods for searching Dictionary objects. The search query is constructed using the DictionaryQuery. The dictionary record Type also specifies the record for the dictionary query.

Dictionaries may have a query record indicated by their respective record types. The query record is accessed via the DictionaryQuery.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchDictionaries() Tests if this user can perform Dictionary searches.
DictionaryList	getDictionariesByQuery(DictionaryQuery dictionaryQuery) Gets a list of Dictionary elements matching the given query.
DictionaryQuery	getDictionaryQuery() Gets a dictionary query.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canSearchDictionaries

boolean canSearchDictionaries()

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

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getDictionaryQuery

DictionaryQuery getDictionaryQuery()

Gets a dictionary query.

Returns:

the dictionary query

Compliance:

mandatory - This method must be implemented.

getDictionariesByQuery

DictionaryList getDictionariesByQuery(DictionaryQuery dictionaryQuery)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a list of Dictionary elements matching the given query.

Parameters:

dictionaryQuery - the dictionary query

Returns:

the returned DictionaryList

Throws:

NullArgumentException - dictionaryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - dictionaryQuery is not of this service

Compliance:

mandatory - This method must be implemented.