org.osid.search

Interface Engine

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Engine
extends OsidCatalog

An Engine represents a search engine. Like all OSID objects, an Engine is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
EngineRecord	getEngineRecord(Type engineRecordType) Gets the engine record corresponding to the given Engine record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getEngineRecord

EngineRecord getEngineRecord(Type engineRecordType)
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets the engine record corresponding to the given Engine record Type. This method is used to retrieve an object implementing the requested record. The engineRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(engineRecordType) is true .

Parameters:

engineRecordType - the type of engine record to retrieve

Returns:

the engine record

Throws:

NullArgumentException - engineRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(engineRecordType) is false

Compliance:

mandatory - This method must be implemented.