Interface AuctionConstrainerEnablerRuleLookupSession

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

This session provides methods to retrieve AuctionConstrainerEnabler to AuctionConstrainer mappings. An AuctionConstrainer with multiple AuctionConstrainerEnablers means any positive rule evaluation across the enablers result in an effective AuctionConstrainer .

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated auction house view: All methods in this session operate, retrieve and pertain auction constrainer enablers defined explicitly in the current auction house
  • federated auction house view: All 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.

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

    • canLookupAuctionConstrainerEnablerRules

      boolean canLookupAuctionConstrainerEnablerRules()
      Tests if this user can perform lookups of auction constrainer enabler/auction constrainer mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeAuctionConstrainerEnablerRuleView

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

    • usePlenaryAuctionConstrainerEnablerRuleView

      void usePlenaryAuctionConstrainerEnablerRuleView()
      A complete view of the AuctionConstrainerEnabler and AuctionConstrainer 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.

    • getAuctionConstrainerEnablerIdsForAuctionConstrainer

      IdList getAuctionConstrainerEnablerIdsForAuctionConstrainer(Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionConstrainerEnablerIds associated with an AuctionConstrainer .
      Parameters:
      auctionConstrainerId - Id of the AuctionConstrainer
      Returns:
      the auction constrainer enabler Ids
      Throws:
      NotFoundException - auctionConstrainerId is not found
      NullArgumentException - auctionConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainerEnablersForAuctionConstrainer

      AuctionConstrainerEnablerList getAuctionConstrainerEnablersForAuctionConstrainer(Id auctionConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionConstrainerEnablers associated with an AuctionConstrainer .
      Parameters:
      auctionConstrainerId - Id of the AuctionConstrainer
      Returns:
      the auction constrainer enablers
      Throws:
      NotFoundException - auctionConstrainerId is not found
      NullArgumentException - auctionConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainerIdsForAuctionConstrainerEnabler

      IdList getAuctionConstrainerIdsForAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionConstrainer Ids mapped to an AuctionConstrainerEnabler .
      Parameters:
      auctionConstrainerEnablerId - Id of an AuctionConstrainerEnabler
      Returns:
      list of auction constrainer Ids
      Throws:
      NotFoundException - auctionConstrainerEnablerId is not found
      NullArgumentException - auctionConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainersForAuctionConstrainerEnabler

      AuctionConstrainerList getAuctionConstrainersForAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AuctionConstrainers mapped to an AuctionConstrainerEnabler .
      Parameters:
      auctionConstrainerEnablerId - Id of an AuctionConstrainerEnabler
      Returns:
      list of auction constrainers
      Throws:
      NotFoundException - auctionConstrainerEnablerId is not found
      NullArgumentException - auctionConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.