Interface BidEnablerLookupSession

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

This session provides methods for retrieving BidEnablers .

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 bid enabler methods in this session operate, retrieve and pertain to bid enablers defined explicitly in the current auction house Using an isolated view is useful for managing BidEnablers with the BidEnablerAdminSession .
  • federated auction house view: All bid enabler methods in this session operate, retrieve and pertain to all bid enablers defined in this auction house and any other bid enablers implicitly available in this auction house through auction house inheritence.

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() b ehave 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.

    • canLookupBidEnablers

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

    • useComparativeBidEnablerView

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

    • usePlenaryBidEnablerView

      void usePlenaryBidEnablerView()
      A complete view of the BidEnabler 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 bid enablers 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.

    • getBidEnabler

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

    • getBidEnablersByIds

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

    • getBidEnablersByGenusType

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

    • getBidEnablersByParentGenusType

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

    • getBidEnablersByRecordType

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

    • getBidEnablers

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