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

This interface provides a means to capture results of a search.

MethodgetBlogs
Description

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

Returnosid.blogging.BlogListthe blog list
ErrorsILLEGAL_STATEthe blog list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetBlogQueryInspector
Description

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

Returnosid.blogging.BlogQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetBlogSearchResultsRecord
Description

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

Parametersosid.type.TypeblogSearchRecordTypea blog search record type
Returnosid.blogging.records.BlogSearchResultsRecordthe blog search rsults record
ErrorsNULL_ARGUMENT blogSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(blogSearchRecordType) is false
CompliancemandatoryThis method must be implemented.