Interface | osid.search.EngineLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving 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 | ||
Method | canLookupEngines | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeEngineView | ||
Description |
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. | |
Method | usePlenaryEngineView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getEngine | ||
Description |
Gets the | ||
Parameters | osid.id.Id | engineId | Id of the Engine |
Return | osid.search.Engine | the engine | |
Errors | NOT_FOUND | engineId not found | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getEnginesByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | engineIds | the list of Ids to retrieve |
Return | osid.search.EngineList | the returned Engine list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | engineIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEnginesByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | engineGenusType | an engine genus type |
Return | osid.search.EngineList | the returned Engine list | |
Errors | NULL_ARGUMENT | engineGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEnginesByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | engineGenusType | an engine genus type |
Return | osid.search.EngineList | the returned Engine list | |
Errors | NULL_ARGUMENT | engineGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEnginesByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | engineRecordType | an engine record type |
Return | osid.search.EngineList | the returned Engine list | |
Errors | NULL_ARGUMENT | engineRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEnginesByProvider | ||
Description |
Gets an | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.search.EngineList | the returned Engine list | |
Errors | NULL_ARGUMENT | resource is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEngines | ||
Description |
Gets all | ||
Return | osid.search.EngineList | a list of Engines | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |