BlogQuerySession

All Superinterfaces:: AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:: BlogSearchSession

public interface BlogQuerySession extends OsidSession

This session provides methods for searching among Blogs. The search query is constructed using the BlogQuery.

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

Like all OsidSessions, BlogQuerySessions are dedicated to single processing threads and a single authenticated user.

Method Summary

Modifier and Type

Method

Description

boolean

canSearchBlogs()

Tests if this user can perform Blog searches.

BlogQuery

getBlogQuery()

Gets a blog query.

BlogList

getBlogsByQuery(BlogQuery blogQuery)

Gets a list of Blogs matching the given search.

Methods inherited from interface Closeable
close

Methods inherited from interface OsidSession
close

Methods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatTypes, getLocales, isAuthenticated, startTransaction, supportsTransactions

Method Details
- canSearchBlogs
  
  boolean canSearchBlogs()
  
  Tests if this user can perform Blog searches. 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.
  
  Returns:
  
  false if search methods are not authorized, true otherwise
  
  Compliance:
  mandatory - This method must be implemented.
- getBlogQuery
  
  BlogQuery getBlogQuery()
  
  Gets a blog query. The returned query will not have an extension query.
  
  Returns:
  
  the blog query
  
  Compliance:
  mandatory - This method must be implemented.
- getBlogsByQuery
  
  BlogList getBlogsByQuery(BlogQuery blogQuery) throws OperationFailedException, PermissionDeniedException
  
  Gets a list of Blogs matching the given search.
  
  Parameters:
  
  blogQuery - the blog query
  
  Returns:
  
  the returned BlogList
  
  Throws:
  
  NullArgumentException - blogQuery is null
  
  OperationFailedException - unable to complete request
  
  PermissionDeniedException - authorization failure
  
  UnsupportedException - a blogQuery is not of this service
  
  Compliance:
  mandatory - This method must be implemented.