Interface AuctionProcessorEnablerLookupSession

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

This session provides methods for retrieving AuctionProcessorEnablers .

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

    • canLookupAuctionProcessorEnablers

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

    • useComparativeAuctionProcessorEnablerView

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

    • usePlenaryAuctionProcessorEnablerView

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

    • useActiveAuctionProcessorEnablerView

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

    • useAnyStatusAuctionProcessorEnablerView

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

    • getAuctionProcessorEnabler

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

    • getAuctionProcessorEnablersByIds

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

    • getAuctionProcessorEnablersByGenusType

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

    • getAuctionProcessorEnablersByParentGenusType

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

    • getAuctionProcessorEnablersByRecordType

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

    • getAuctionProcessorEnablersOnDate

      AuctionProcessorEnablerList getAuctionProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuctionProcessorEnablerList effective within the given date range. In plenary mode, the returned list contains all known auction processor enablers or an error results. Otherwise, the returned list may contain only those auction processor enablers that are accessible through this session. In active mode, auction processor enablers are returned that are currently active. In any status mode, active and inactive auction processor enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned AuctionProcessorEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionProcessorEnablersOnDateWithAgent

      AuctionProcessorEnablerList getAuctionProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuctionProcessorEnablerList effective during the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known auction processor enablers or an error results. Otherwise, the returned list may contain only those auction processor enablers that are accessible through this session. In active mode, auction processor enablers are returned that are currently active. In any status mode, active and inactive auction processor enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned AuctionProcessorEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionProcessorEnablers

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