OSID Logo
OSID Specifications
blogging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.BlogSearchSession
Implementsosid.blogging.BlogQuerySession
Description

This session provides methods for searching among Blog objects. The search query is constructed using the BlogQuery.

getBlogsByQuery() is the basic search method and returns a list of Blog objects.A more advanced search may be performed with getBlogsBySearch(). It accepts a BlogSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBlogsBySearch() returns a BlogSearchResults that can be used to access the resulting BlogList or be used to perform a search within the result set through BlogSearch.

Blogs may have a query record indicated by their respective record types. The query record is accessed via the BlogQuery.

MethodgetBlogSearch
Description

Gets a blog search.

Returnosid.blogging.BlogSearchthe blog search
CompliancemandatoryThis method must be implemented.
MethodgetBlogSearchOrder
Description

Gets a blog search order. The BlogSearchOrder is supplied to a BlogSearch to specify the ordering of results.

Returnosid.blogging.BlogSearchOrderthe blog search order
CompliancemandatoryThis method must be implemented.
MethodgetBlogsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.blogging.BlogQueryblogQuerythe blog query
osid.blogging.BlogSearchblogSearchthe blog search
Returnosid.blogging.BlogSearchResultsthe search results
ErrorsNULL_ARGUMENT blogQuery or blogSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED blogQuery or blogSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBlogQueryFromInspector
Description

Gets a blog query from an inspector. The inspector is available from an BlogSearchResults.

Parametersosid.blogging.BlogQueryInspectorblogQueryInspectora query inspector
Returnosid.blogging.BlogQuerythe blog query
ErrorsNULL_ARGUMENT blogQueryInspector is null
UNSUPPORTED blogQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.