Interface JournalLookupSession

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

This session provides methods for retrieving Journals . The Journal represents a collection of journal 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

  • Method Details

    • canLookupJournals

      boolean canLookupJournals()
      Tests if this user can perform Journal 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 not offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeJournalView

      void useComparativeJournalView()
      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.

    • usePlenaryJournalView

      void usePlenaryJournalView()
      A complete view of the Journal 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.

    • getJournal

      Journal getJournal(Id journalId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Journal specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Journal may have a different Id than requested, such as the case where a duplicate Id was assigned to a Journal and retained for compatibility.
      Parameters:
      journalId - Id of the Journal
      Returns:
      the journal
      Throws:
      NotFoundException - journalId not found
      NullArgumentException - journalId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getJournalsByIds

      JournalList getJournalsByIds(IdList journalIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a JournalList corresponding to the given IdList . In plenary mode, the returned list contains all of the journals 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 Journals may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      journalIds - the list of Ids to retrieve
      Returns:
      the returned Journal list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - journalIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJournalsByGenusType

      JournalList getJournalsByGenusType(Type journalGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a JournalList corresponding to the given journal genus Type which does not include journals of genus types derived from the specified Type . In plenary mode, the returned list contains all known journals or an error results. Otherwise, the returned list may contain only those journals that are accessible through this session.
      Parameters:
      journalGenusType - a journal genus type
      Returns:
      the returned Journal list
      Throws:
      NullArgumentException - journalGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJournalsByParentGenusType

      JournalList getJournalsByParentGenusType(Type journalGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a JournalList corresponding to the given journal genus Type and include any additional journals with genus types derived from the specified Type . In plenary mode, the returned list contains all known journals or an error results. Otherwise, the returned list may contain only those journals that are accessible through this session.
      Parameters:
      journalGenusType - a journal genus type
      Returns:
      the returned Journal list
      Throws:
      NullArgumentException - journalGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJournalsByRecordType

      JournalList getJournalsByRecordType(Type journalRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a JournalList containing the given journal record Type . In plenary mode, the returned list contains all known journals or an error results. Otherwise, the returned list may contain only those journals that are accessible through this session.
      Parameters:
      journalRecordType - a journal record type
      Returns:
      the returned Journal list
      Throws:
      NullArgumentException - journalRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJournalsByProvider

      JournalList getJournalsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a JournalList for the given provider. In plenary mode, the returned list contains all known journals or an error results. Otherwise, the returned list may contain only those journals that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Journal list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getJournals

      JournalList getJournals() throws OperationFailedException, PermissionDeniedException
      Gets all Journals . In plenary mode, the returned list contains all known journals or an error results. Otherwise, the returned list may contain only those journals that are accessible through this session.
      Returns:
      a list of Journals
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.