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

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

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 types. The query record is accessed via the EntryQuery.

MethodgetBlogId
Description

Gets the Blog Id associated with this session.

Returnosid.id.Idthe Blog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBlog
Description

Gets the Blog associated with this session.

Returnosid.blogging.Blogthe Blog associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchEntries
Description

Tests if this user can perform Entry queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedBlogView
Description

Federates the view for methods in this session. A federated view will include entries in blogs which are children of this blog in the blog hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBlogView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this blog only.

CompliancemandatoryThis method is must be implemented.
MethodgetEntryQuery
Description

Gets an entry query.

Returnosid.blogging.EntryQuerythe entry query interface
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByQuery
Description

Gets a list of Entries matching the given search.

Parametersosid.blogging.EntryQueryentryQuerythe entry query
Returnosid.blogging.EntryListthe returned EntryList
ErrorsNULL_ARGUMENT entryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED entryQuery is not of this service
CompliancemandatoryThis method must be implemented.