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

This session provides methods for retrieving Blog objects. The Blog represents a collection entries.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Blogs it can access, without breaking execution. However, an administrative application may require all Blog elements to be available.

Blogs may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Blog.

MethodcanLookupBlogs
Description

Tests if this user can perform Blog lookups. 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 lookup operations to unauthorized users.

Returnboolean false if lookup methods are 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 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.
MethodgetBlog
Description

Gets the Blog specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Blog may have a different Id than requested, such as the case where a duplicate Id was assigned to a Blog and retained for compatibility.

Parametersosid.id.IdblogId Id of the Blog
Returnosid.blogging.Blogthe blog
ErrorsNOT_FOUND blogId not found
NULL_ARGUMENT blogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetBlogsByIds
Description

Gets a BlogList corresponding to the given IdList. In plenary mode, the returned list contains all of the blogs specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible blogs may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListblogIdsthe list of Ids to retrieve
Returnosid.blogging.BlogListthe returned Blog list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT blogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlogsByGenusType
Description

Gets a Blog corresponding to the given blog genus Type which does not include blogs of types derived from the specified Type. In plenary mode, the returned list contains all known blogs or an error results. Otherwise, the returned list may contain only those blogs that are accessible through this session.

Parametersosid.type.TypeblogGenusTypea blog genus type
Returnosid.blogging.BlogListthe returned Blog list
ErrorsNULL_ARGUMENT blogGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlogsByParentGenusType
Description

Gets a BlogList corresponding to the given psocess genus Type and include any additional blogs with genus types derived from the specified Type. In plenary mode, the returned list contains all known blogs or an error results. Otherwise, the returned list may contain only those blogs that are accessible through this session.

Parametersosid.type.TypeblogGenusTypea blog genus type
Returnosid.blogging.BlogListthe returned Blog list
ErrorsNULL_ARGUMENT blogGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlogsByRecordType
Description

Gets a BlogList containing the given blog record Type. In plenary mode, the returned list contains all known blogs or an error results. Otherwise, the returned list may contain only those blogs that are accessible through this session.

Parametersosid.type.TypeblogRecordTypea blog record type
Returnosid.blogging.BlogListthe returned Blog list
ErrorsNULL_ARGUMENT blogRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlogsByProvider
Description

Gets a BlogList for the given provider. In plenary mode, the returned list contains all known blogs or an error results. Otherwise, the returned list may contain only those blogs that are accessible through this session.

Parametersosid.id.IdresourceIda resourceId Id
Returnosid.blogging.BlogListthe returned Blog list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBlogs
Description

Gets all Blogs. In plenary mode, the returned list contains all known blogs or an error results. Otherwise, the returned list may contain only those blogs that are accessible through this session.

Returnosid.blogging.BlogLista list of blogs
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.