Interface BlogLookupSession

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

This session provides methods for retrieving Blogs . 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 .

  • Method Details

    • canLookupBlogs

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

    • useComparativeBlogView

      void useComparativeBlogView()
      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.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryBlogView

      void usePlenaryBlogView()
      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.
      Compliance:
      mandatory - This method is must be implemented.

    • getBlog

      Blog getBlog(Id blogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      blogId - Id of the Blog
      Returns:
      the blog
      Throws:
      NotFoundException - blogId not found
      NullArgumentException - blogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getBlogsByIds

      BlogList getBlogsByIds(IdList blogIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      blogIds - the list of Ids to retrieve
      Returns:
      the returned Blog list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - blogIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBlogsByGenusType

      BlogList getBlogsByGenusType(Type blogGenusType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      blogGenusType - a blog genus type
      Returns:
      the returned Blog list
      Throws:
      NullArgumentException - blogGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBlogsByParentGenusType

      BlogList getBlogsByParentGenusType(Type blogGenusType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      blogGenusType - a blog genus type
      Returns:
      the returned Blog list
      Throws:
      NullArgumentException - blogGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBlogsByRecordType

      BlogList getBlogsByRecordType(Type blogRecordType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      blogRecordType - a blog record type
      Returns:
      the returned Blog list
      Throws:
      NullArgumentException - blogRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBlogsByProvider

      BlogList getBlogsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      resourceId - a resourceId Id
      Returns:
      the returned Blog list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getBlogs

      BlogList getBlogs() throws OperationFailedException, PermissionDeniedException
      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.
      Returns:
      a list of blogs
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.