Interface AuctionProcessorLookupSession

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

This session provides methods for retrieving AuctionProcessors .

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 processor methods in this session operate, retrieve and pertain to auction processor defined explicitly in the current auction house. Using an isolated view is useful for managing AuctionProcessors with the AuctionProcessorAdminSession .
  • federated auction house view: All auction processor methods in this session operate, retrieve and pertain to all auction processor defined in this auction house and any other auction processor implicitly available in this auction house through auction house inheritence.
  • active auction processor view: All auction processor lookup methods return active auction processors.
  • any status auction processor view: Auction processors of any active or inactive status 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 useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

  • 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.

    • canLookupAuctionProcessors

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

    • useComparativeAuctionProcessorView

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

    • usePlenaryAuctionProcessorView

      void usePlenaryAuctionProcessorView()
      A complete view of the AuctionProcessor 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 auction processor 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.

    • useActiveAuctionProcessorView

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

    • useAnyStatusAuctionProcessorView

      void useAnyStatusAuctionProcessorView()
      All active and inactive auction processors are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getAuctionProcessor

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

    • getAuctionProcessorsByIds

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

    • getAuctionProcessorsByGenusType

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

    • getAuctionProcessorsByParentGenusType

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

    • getAuctionProcessorsByRecordType

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

    • getAuctionProcessors

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