org.osid.dictionary

Interface EntrySmartDictionarySession

All Superinterfaces:

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

public interface EntrySmartDictionarySession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A EntryQuery can be retrieved from this session and mapped to this Dictionary to create a virtual collection of Entries. The entries may be sequenced using the EntrySearchOrder from this session.

This Dictionary has a default query that matches any entry and a default search order that specifies no sequencing. The queries may be examined using a EntryQueryInspector. The query may be modified by converting the inspector back to a EntryQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyEntryQuery(EntryQuery entryQuery) Applies a entry query to this dictionary.
void	applyEntrySequencing(EntrySearchOrder entrySearchOrder) Applies a entry search order to this dictionary.
boolean	canManageSmartDictionaries() Tests if this user can manage smart dictionarys.
Dictionary	getDictionary() Gets the Dictionary associated with this session.
Id	getDictionaryId() Gets the Dictionary Id associated with this session.
EntryQuery	getEntryQuery() Gets a entry query.
EntryQuery	getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector) Gets a entry query from an inspector.
EntrySearchOrder	getEntrySearchOrder() Gets a entry search order.
EntryQueryInspector	inspectEntryQuery() Gets a entry query inspector for this dictionary.

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

getDictionaryId

Id getDictionaryId()

Gets the Dictionary Id associated with this session.

Returns:

the Dictionary Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDictionary

Dictionary getDictionary()
                         throws OperationFailedException,
                                PermissionDeniedException

Gets the Dictionary associated with this session.

Returns:

the Dictionary associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartDictionaries

boolean canManageSmartDictionaries()

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

Returns:

false if smart dictionary management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getEntryQuery

EntryQuery getEntryQuery()

Gets a entry query.

Returns:

the entry query

Compliance:

mandatory - This method must be implemented.

getEntrySearchOrder

EntrySearchOrder getEntrySearchOrder()

Gets a entry search order.

Returns:

the entry search order

Compliance:

mandatory - This method must be implemented.

applyEntryQuery

void applyEntryQuery(EntryQuery entryQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies a entry query to this dictionary.

Parameters:

entryQuery - the entry query

Throws:

NullArgumentException - entryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - entryQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectEntryQuery

EntryQueryInspector inspectEntryQuery()
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a entry query inspector for this dictionary.

Returns:

the entry query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyEntrySequencing

void applyEntrySequencing(EntrySearchOrder entrySearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a entry search order to this dictionary.

Parameters:

entrySearchOrder - the entry search order

Throws:

NullArgumentException - entrySearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - entrySearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getEntryQueryFromInspector

EntryQuery getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)

Gets a entry query from an inspector.

Parameters:

entryQueryInspector - a entry query inspector

Returns:

the entry query

Throws:

NullArgumentException - entryQueryInspector is null

UnsupportedException - entryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.