public interface EngineLookupSession extends OsidSession
This session provides methods for retrieving Engine
objects. The Engine
represents a search engine.
This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. For
example, a browsing application may only need to examine the
Engines
it can access, without breaking execution. However, an
assessment may only be useful if all Engines
referenced by
it are available, and a test-taking applicationmay sacrifice some
interoperability for the sake of precision.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupEngines()
Tests if this user can perform
Engine lookups. |
Engine |
getEngine(Id engineId)
Gets the
Engine specified by its Id. |
EngineList |
getEngines()
Gets all
Engines. |
EngineList |
getEnginesByGenusType(Type engineGenusType)
Gets an
EngineList corresponding to the given engine
genus Type which does not include engines of genus
types derived from the specified Type. |
EngineList |
getEnginesByIds(IdList engineIds)
Gets an
EngineList corresponding to the given
IdList. |
EngineList |
getEnginesByParentGenusType(Type engineGenusType)
Gets an
EngineList corresponding to the given engine
genus Type and include any additional engines with
genus types derived from the specified Type. |
EngineList |
getEnginesByProvider(Id resourceId)
Gets an
EngineList for the given provider . |
EngineList |
getEnginesByRecordType(Type engineRecordType)
Gets an
EngineList containing the given engine record
Type. |
void |
useComparativeEngineView()
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 |
usePlenaryEngineView()
A complete view of the
Engine returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupEngines()
Engine
lookups. 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 not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeEngineView()
mandatory
- This method is must be implemented. void usePlenaryEngineView()
Engine
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.mandatory
- This method is must be implemented. Engine getEngine(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Engine
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Engine
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to an
Engine
and retained for compatibility.engineId
- Id
of the Engine
NotFoundException
- engineId
not foundNullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. EngineList getEnginesByIds(IdList engineIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
EngineList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
engines 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 Engines
may be omitted from the list and
may present the elements in any order including returning a unique
set.engineIds
- the list of Ids
to retrieve Engine
listNotFoundException
- an Id was
not foundNullArgumentException
- engineIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EngineList getEnginesByGenusType(Type engineGenusType) throws OperationFailedException, PermissionDeniedException
EngineList
corresponding to the given engine
genus Type
which does not include engines of genus
types derived from the specified Type.
In plenary mode,
the returned list contains all known engines or an error results.
Otherwise, the returned list may contain only those engines that are
accessible through this session.engineGenusType
- an engine genus type Engine
listNullArgumentException
- engineGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EngineList getEnginesByParentGenusType(Type engineGenusType) throws OperationFailedException, PermissionDeniedException
EngineList
corresponding to the given engine
genus Type
and include any additional engines with
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known engines or an error
results. Otherwise, the returned list may contain only those engines
that are accessible through this session.engineGenusType
- an engine genus type Engine
listNullArgumentException
- engineGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EngineList getEnginesByRecordType(Type engineRecordType) throws OperationFailedException, PermissionDeniedException
EngineList
containing the given engine record
Type.
In plenary mode, the returned list contains all
known engines or an error results. Otherwise, the returned list may
contain only those engines that are accessible through this session.engineRecordType
- an engine record type Engine
listNullArgumentException
- engineRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EngineList getEnginesByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
EngineList
for the given provider .
In plenary mode, the returned list contains all known engines
or an error results. Otherwise, the returned list may contain only
those engines that are accessible through this session.resourceId
- a resource Id
Engine
listNullArgumentException
- resource
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EngineList getEngines() throws OperationFailedException, PermissionDeniedException
Engines.
In plenary mode, the returned list
contains all known engines or an error results. Otherwise, the
returned list may contain only those engines that are accessible
through this session. Engines
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.