OSID Logo
OSID Specifications
blogging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.EntrySearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to access results of a search and any data available from executing the search.

MethodgetEntries
Description

Gets the entry list resulting from a search. This is a retrieve-once method. Another list may be created through performing another search.

Returnosid.blogging.EntryListthe entry list
ErrorsILLEGAL_STATEthe entry list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetEntryQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.blogging.EntryQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetEntrySearchResultsRecord
Description

Gets the blog entry search results record corresponding to the given entry search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeentrySearchRecordTypean entry search record type
Returnosid.blogging.records.EntrySearchResultsRecordthe entry search results record
ErrorsNULL_ARGUMENT entrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.