Interface PostQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
PostSearchSession
public interface PostQuerySession extends OsidSession

This session provides methods for searching Posts. The search query is constructed using the PostQuery. The post record Type also specifies the record for the post query.

Posts may have a query record indicated by their respective record types. The query record is accessed via the PostQuery. The returns in this session may not be cast directly to these interfaces.

  • Method Details

    • getForumId

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

    • getForum

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

    • useFederatedForumView

      void useFederatedForumView()
      Federates the view for methods in this session. A federated view will include posts in forums which are children of this forum in the forum hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedForumView

      void useIsolatedForumView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this forum only.
      Compliance:
      mandatory - This method is must be implemented.

    • canSearchPosts

      boolean canSearchPosts()
      Tests if this user can perform Post 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.

    • getPostQuery

      PostQuery getPostQuery()
      Gets a post query.
      Returns:
      the post query
      Compliance:
      mandatory - This method must be implemented.

    • getPostsByQuery

      PostList getPostsByQuery(PostQuery postQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Posts matching the given search.
      Parameters:
      postQuery - the post query
      Returns:
      the returned PostList
      Throws:
      NullArgumentException - postQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - postQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.