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

This session provides methods to retrieve Entry to Blog mappings. An Entry may appear in multiple Blogs. Each Blog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupEntryBlogMappings
Description

Tests if this user can perform lookups of entry/blog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBlogView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBlogView
Description

A complete view of the Entry and Blog returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetEntryIdsByBlog
Description

Gets the list of Entry Ids associated with a Blog.

Parametersosid.id.IdblogId Id of a Blog
Returnosid.id.IdListlist of related entry Ids
ErrorsNOT_FOUND blogId is not found
NULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByBlog
Description

Gets the list of Entries associated with a Blog.

Parametersosid.id.IdblogId Id of a Blog
Returnosid.blogging.EntryListlist of related entries
ErrorsNOT_FOUND blogId is not found
NULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntryIdsByBlogs
Description

Gets the list of Entry Ids corresponding to a list of Blog objects.

Parametersosid.id.IdListblogIdslist of blog Ids
Returnosid.id.IdListlist of entry Ids
ErrorsNULL_ARGUMENT blogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetEntriesByBlogs
Description

Gets the list of Entries corresponding to a list of Blogs.

Parametersosid.id.IdListblogIdslist of blog Ids
Returnosid.blogging.EntryListlist of entries
ErrorsNULL_ARGUMENT blogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlogIdsByEntry
Description

Gets the list of Blog Ids mapped to a Entry.

Parametersosid.id.IdentryId Id of an Entry
Returnosid.id.IdListlist of blog Ids
ErrorsNOT_FOUND entryId is not found
NULL_ARGUMENT entryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlogsByEntry
Description

Gets the list of Blog objects mapped to an Entry.

Parametersosid.id.IdentryId Id of an Entry
Returnosid.blogging.BlogListlist of blogs
ErrorsNOT_FOUND entryId is not found
NULL_ARGUMENT entryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.