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

This session manages queries and sequencing to create "smart" dynamic catalogs. An EntryQuery can be retrieved from this session and mapped to this Blog to create a virtual collection of Entries. The entries may be sequenced using the EntrySearchOrder from this session.

This Blog has a default query that matches any entry and a default search order that specifies no sequencing. The queries may be examined using an EntryQueryInspector. The query may be modified by converting the inspector back to an 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.
MethodcanManageSmartBlogs
Description

Tests if this user can manage smart blogs. 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 smart operations.

Returnboolean false if smart blog methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEntryQuery
Description

Gets an entry query.

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

Gets an entry search order.

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

Applies an entry query to this blog.

Parametersosid.blogging.EntryQueryentryQuerythe entry query
ErrorsNULL_ARGUMENT entryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED entryQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectEntryQuery
Description

Gets an entry query inspector for this blog.

Returnosid.blogging.EntryQueryInspectorthe entry query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyEntrySequencing
Description

Applies an entry search order to this blog.

Parametersosid.blogging.EntrySearchOrderentrySearchOrderthe entry search order
ErrorsNULL_ARGUMENT entrySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED entrySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEntryQueryFromInspector
Description

Gets an entry query from an inspector.

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.