org.osid.dictionary

Interface EntryLookupSession

All Superinterfaces:

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

public interface EntryLookupSession
extends EntryRetrievalSession

EntryLookupSession is used to look up dictionary entries. This session includes the methods defined in the EntryRetrievalSession.

This session defines two views which offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete and ordered result set or is an error condition

Generally, the comparative view should be used for most applications as it permits operation even if there is data out of sync or there is an authorization block in a particular element.

Method Summary

Methods

Modifier and Type	Method and Description
EntryList	getEntries() Gets all the Dictionary entries.
EntryList	getEntriesByGenusType(Type entryGenusType) Gets an EntryList corresponding to the given entry genus Type which does not include entries of genus types derived from the specified Type.
EntryList	getEntriesByIds(IdList entryIds) Gets an EntryList corresponding to the given IdList.
EntryList	getEntriesByKeyAndKeyType(java.lang.Object key, Type keyType) Gets all the Dictionary entries matching the given key and key Type .
EntryList	getEntriesByKeyType(Type keyType) Gets all the Dictionary entries matching the given key Type.
EntryList	getEntriesByKeyTypeAndValueType(Type keyType, Type valueType) Gets all the Dictionary entries matching the given key and value Type.
EntryList	getEntriesByParentGenusType(Type entryGenusType) Gets an EntryList corresponding to the given entry genus Type and include any additional entries with genus types derived from the specified Type.
EntryList	getEntriesByRecordType(Type entryyRecordType) Gets an EntryList containing the given entry record Type.
Entry	getEntry(Id entryId) Gets the Entry specified by its Id.
void	useComparativeEntryView() 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	usePlenaryEntryView() A complete view of the Entry returns is desired.

Methods inherited from interface org.osid.dictionary.EntryRetrievalSession

canLookupEntries, getDictionary, getDictionaryId, retrieveEntry, useFederatedDictionaryView, useIsolatedDictionaryView

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

useComparativeEntryView

void useComparativeEntryView()

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.

usePlenaryEntryView

void usePlenaryEntryView()

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

getEntry

Entry getEntry(Id entryId)
               throws NotFoundException,
                      OperationFailedException,
                      PermissionDeniedException

Gets the Entry specified by its Id. The identifier represents the union of the key, keyType and valueType.In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Entry may have a different Id than requested, such as the case where a duplicate Id was assigned to an Agency and retained for compatibility.

Parameters:

entryId - Id of the Entry

Returns:

the entry

Throws:

NotFoundException - entryId not found

NullArgumentException - entryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getEntriesByIds

EntryList getEntriesByIds(IdList entryIds)
                          throws NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Gets an EntryList corresponding to the given IdList. In plenary mode, the returned list contains all of the entries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Entry elements may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

entryIds - a list of Entry Ids

Returns:

the entry list

Throws:

NotFoundException - entryId not found

NullArgumentException - entryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getEntriesByGenusType

EntryList getEntriesByGenusType(Type entryGenusType)
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets an EntryList corresponding to the given entry genus Type which does not include entries of genus types derived from the specified Type. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Parameters:

entryGenusType - an entry genus type

Returns:

the returned Entry list

Throws:

NullArgumentException - entryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByParentGenusType

EntryList getEntriesByParentGenusType(Type entryGenusType)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets an EntryList corresponding to the given entry genus Type and include any additional entries with genus types derived from the specified Type. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Parameters:

entryGenusType - an entry genus type

Returns:

the returned Entry list

Throws:

NullArgumentException - entryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByRecordType

EntryList getEntriesByRecordType(Type entryyRecordType)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets an EntryList containing the given entry record Type. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.

Parameters:

entryyRecordType - an entry record type

Returns:

the returned Entry list

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByKeyType

EntryList getEntriesByKeyType(Type keyType)
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets all the Dictionary entries matching the given key Type. In plenary mode, the returned list contains all of the entries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Entry elements may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

keyType - the type of the key to match

Returns:

the list of entries matching keyType

Throws:

NullArgumentException - keyType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByKeyTypeAndValueType

EntryList getEntriesByKeyTypeAndValueType(Type keyType,
                                        Type valueType)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets all the Dictionary entries matching the given key and value Type. In plenary mode, the returned list contains all of the entries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Entry elements may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

keyType - the type of the key to match

valueType - the type of the value to match

Returns:

the list of entries matching keyType

Throws:

NullArgumentException - keyType or valueType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntriesByKeyAndKeyType

EntryList getEntriesByKeyAndKeyType(java.lang.Object key,
                                  Type keyType)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets all the Dictionary entries matching the given key and key Type . In plenary mode, the returned list contains all of the entries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Entry elements may be omitted from the list and may present the elements in any order including returning a unique set.

Parameters:

key - the key to match

keyType - the type of the value to match

Returns:

the list of entries matching keyType

Throws:

NullArgumentException - key or keyType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getEntries

EntryList getEntries()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets all the Dictionary entries. In plenary mode, the returned list contains all of the entries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Entry elements may be omitted from the list and may present the elements in any order including returning a unique set.

Returns:

the list of entries

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.