Interface EntrySmartBlogSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface EntrySmartBlogSession extends OsidSession

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 .

  • Method Details

    • getBlogId

      Id getBlogId()
      Gets the Blog Id associated with this session.
      Returns:
      the Blog Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getBlog

      Blog getBlog() throws OperationFailedException, PermissionDeniedException
      Gets the Blog associated with this session.
      Returns:
      the Blog associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartBlogs

      boolean canManageSmartBlogs()
      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.
      Returns:
      false if smart blog methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEntryQuery

      EntryQuery getEntryQuery()
      Gets an entry query.
      Returns:
      the entry query
      Compliance:
      mandatory - This method must be implemented.

    • getEntrySearchOrder

      EntrySearchOrder getEntrySearchOrder()
      Gets an entry search order.
      Returns:
      the entry search order
      Compliance:
      mandatory - This method must be implemented.

    • applyEntryQuery

      void applyEntryQuery(EntryQuery entryQuery) throws OperationFailedException, PermissionDeniedException
      Applies an entry query to this blog.
      Parameters:
      entryQuery - the entry query
      Throws:
      NullArgumentException - entryQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - entryQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectEntryQuery

      EntryQueryInspector inspectEntryQuery() throws OperationFailedException, PermissionDeniedException
      Gets an entry query inspector for this blog.
      Returns:
      the entry query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyEntrySequencing

      void applyEntrySequencing(EntrySearchOrder entrySearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an entry search order to this blog.
      Parameters:
      entrySearchOrder - the entry search order
      Throws:
      NullArgumentException - entrySearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - entrySearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getEntryQueryFromInspector

      EntryQuery getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)
      Gets an entry query from an inspector.
      Parameters:
      entryQueryInspector - a query inspector
      Returns:
      the entry query
      Throws:
      NullArgumentException - entryQueryInspector is null
      UnsupportedException - entryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.