OSID Logo
OSID Specifications
blogging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.EntrySearchSession
Implementsosid.blogging.EntryQuerySession
Description

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

getEntriesByQuery() is the basic search method and returns a list of Entries. A more advanced search may be performed with getEntriesBySearch(). It accepts an EntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEntriesBySearch() returns an EntrySearchResults that can be used to access the resulting EntryList or be used to perform a search within the result set through EntryList.

This session defines views that offer differing behaviors for searching.

  • federated blog view: searches include entries in blogs of which this blog is a ancestor in the blog hierarchy
  • isolated blog view: searches are restricted to entries in this blog

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

MethodgetEntrySearch
Description

Gets an entry search.

Returnosid.blogging.EntrySearchthe entry search
CompliancemandatoryThis method must be implemented.
MethodgetEntrySearchOrder
Description

Gets an entry search order. The EntrySearchOrder is supplied to an EntrySearch to specify the ordering of results.

Returnosid.blogging.EntrySearchOrderthe entry search order
CompliancemandatoryThis method must be implemented.
MethodgetEntriesBySearch
Description

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

Parametersosid.blogging.EntryQueryentryQuerythe entry query
osid.blogging.EntrySearchentrySearchthe entry search
Returnosid.blogging.EntrySearchResultsthe returned search results
ErrorsNULL_ARGUMENT entryQuery or entrySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED entryQuery or entrySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEntryQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an EntrySearchResults.

Parametersosid.blogging.EntryQueryInspectorentryQueryInspectora query inspector
Returnosid.blogging.EntryQuerythe entry query
ErrorsNULL_ARGUMENT entryQueryInspector is null
UNSUPPORTED entryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.