Interface AuctionConstrainerEnablerLookupSession

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

This session provides methods for retrieving AuctionConstrainerEnablers .

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

    • canLookupAuctionConstrainerEnablers

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

    • useComparativeAuctionConstrainerEnablerView

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

    • usePlenaryAuctionConstrainerEnablerView

      void usePlenaryAuctionConstrainerEnablerView()
      A complete view of the AuctionConstrainerEnabler 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 constrainer 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.

    • useActiveAuctionConstrainerEnablerView

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

    • useAnyStatusAuctionConstrainerEnablerView

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

    • getAuctionConstrainerEnabler

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

    • getAuctionConstrainerEnablersByIds

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

    • getAuctionConstrainerEnablersByGenusType

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

    • getAuctionConstrainerEnablersByParentGenusType

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

    • getAuctionConstrainerEnablersByRecordType

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

    • getAuctionConstrainerEnablersOnDate

      AuctionConstrainerEnablerList getAuctionConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuctionConstrainerEnablerList that are effective for the entire given date range but not confined to the date range. In plenary mode, the returned list contains all known auction constrainer enablers or an error results. Otherwise, the returned list may contain only those auction constrainer enablers that are accessible through this session. In active mode, auction constrainer enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive auction constrainer enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned AuctionConstrainerEnabler 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.

    • getAuctionConstrainerEnablersOnDateWithAgent

      AuctionConstrainerEnablerList getAuctionConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an AuctionConstrainerEnablerList that are effective for 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 constrainer enablers or an error results. Otherwise, the returned list may contain only those auction constrainer enablers that are accessible through this session. In active mode, auction constrainer enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive auction constrainer enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned AuctionConstrainerEnabler 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.

    • getAuctionConstrainerEnablers

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