Interface AuctionHouseLookupSession

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

This session provides methods for retrieving AuctionHouses . The AuctionHouse represents a collection of items and auctions.

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 AuctionHouses it can access, without breaking execution. However, an assessment may only be useful if all AuctionHouses referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

  • Method Details

    • canLookupAuctionHouses

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

    • useComparativeAuctionHouseView

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

    • usePlenaryAuctionHouseView

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

    • getAuctionHouse

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

    • getAuctionHousesByIds

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

    • getAuctionHousesByGenusType

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

    • getAuctionHousesByParentGenusType

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

    • getAuctionHousesByRecordType

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

    • getAuctionHousesByProvider

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

    • getAuctionHouses

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