Interface PressLookupSession

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

This session provides methods for retrieving Presses .

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 presses as it permits operation even if there is data that cannot be accessed. For example, a browsing press may only need to examine the Presses it can access, without breaking execution. However, an assessment may only be useful if all Presses referenced by it are available, and a test-taking press may sacrifice some interoperability for the sake of precision.

  • Method Details

    • canLookupPresses

      boolean canLookupPresses()
      Tests if this user can perform Press 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 press 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.

    • useComparativePressView

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

    • usePlenaryPressView

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

    • getPress

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

    • getPressesByIds

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

    • getPressesByGenusType

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

    • getPressesByParentGenusType

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

    • getPressesByRecordType

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

    • getPressesByProvider

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

    • getPresses

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