Interface AuctionLookupSession

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

This session provides methods for retrieving Auctions . The Auction represents a fixed connection between two Items .

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
  • isolated auction house view: All auction methods in this session operate, retrieve and pertain to auctions defined explicitly in the current auction house. Using an isolated view is useful for managing Auctions with the AuctionAdminSession .
  • federated auction house view: All auction methods in this session operate, retrieve and pertain to all auctions defined in this auction house and any other auctions implicitly available in this auction house through auction house inheritence.
  • active auction view: All auction lookup methods return active auctions.
  • any status auction view: Active and inactive auctions are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedAuctionHouseView() and useIsolatedAuctionHouseView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getAuctionHouseId

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

    • getAuctionHouse

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

    • canLookupAuctions

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

    • useComparativeAuctionView

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

    • usePlenaryAuctionView

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

    • useFederatedAuctionHouseView

      void useFederatedAuctionHouseView()
      Federates the view for methods in this session. A federated view will include auctions in auction houses which are children of this auction house in the auction house hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedAuctionHouseView

      void useIsolatedAuctionHouseView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this auction house only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActiveAuctionView

      void useActiveAuctionView()
      Only active auctions are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusAuctionView

      void useAnyStatusAuctionView()
      Active and inactive auctions are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getAuction

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

    • getAuctionsByIds

      AuctionList getAuctionsByIds(IdList auctionIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an AuctionList corresponding to the given IdList . In plenary mode, the returned list contains all of the auctions 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 Auctions may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.
      Parameters:
      auctionIds - the list of Ids to retrieve
      Returns:
      the returned Auction list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - auctionIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionsByGenusType

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

    • getAuctionsByParentGenusType

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

    • getAuctionsByRecordType

      AuctionList getAuctionsByRecordType(Type auctionRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an AuctionList containing the given auction record Type . In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions that are accessible through this session. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.
      Parameters:
      auctionRecordType - an auction record type
      Returns:
      the returned Auction list
      Throws:
      NullArgumentException - auctionRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionsByProvider

      AuctionList getAuctionsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets an AuctionList from the given provider. In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions that are accessible through this session. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Auction list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionsByItem

      AuctionList getAuctionsByItem(Id itemId) throws OperationFailedException, PermissionDeniedException
      Gets a list of auctions for an item. In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions that are accessible through this session. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.
      Parameters:
      itemId - a resource Id
      Returns:
      the returned Auction list
      Throws:
      NullArgumentException - itemId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionsByItemGenusType

      AuctionList getAuctionsByItemGenusType(Type itemGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a list of auctions for an item genus type. In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions that are accessible through this session. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.
      Parameters:
      itemGenusType - an item genus type
      Returns:
      the returned Auction list
      Throws:
      NullArgumentException - itemGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctions

      AuctionList getAuctions() throws OperationFailedException, PermissionDeniedException
      Gets all Auctions . In plenary mode, the returned list contains all known auctions or an error results. Otherwise, the returned list may contain only those auctions that are accessible through this session. In active mode, auctions are returned that are currently active. In any status mode, active and inactive auctions are returned.
      Returns:
      a list of Auctions
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.