Interface AuctionConstrainerEnablerAdminSession

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

This session creates and removes auction constrainer enablers. The data for create and update is provided via the AuctionConstrainerEnablerForm .

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

    • canCreateAuctionConstrainerEnabler

      boolean canCreateAuctionConstrainerEnabler()
      Tests if this user can create auction constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an AuctionConstrainerEnabler will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
      Returns:
      false if AuctionConstrainerEnabler creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateAuctionConstrainerEnablerWithRecordTypes

      boolean canCreateAuctionConstrainerEnablerWithRecordTypes(Type[] auctionConstrainerEnablerRecordTypes)
      Tests if this user can create a single AuctionConstrainerEnabler using the desired record types. While BiddingRulesManager.getAuctionConstrainerEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific AuctionConstrainerEnabler . Providing an empty array tests if an AuctionConstrainerEnabler can be created with no records.
      Parameters:
      auctionConstrainerEnablerRecordTypes - array of auction constrainer enabler record types
      Returns:
      true if AuctionConstrainerEnabler creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - auctionConstrainerEnablerRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainerEnablerFormForCreate

      AuctionConstrainerEnablerForm getAuctionConstrainerEnablerFormForCreate(Type[] auctionConstrainerEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the auction constrainer enabler form for creating new auction constrainer enablers. A new form should be requested for each create transaction.
      Parameters:
      auctionConstrainerEnablerRecordTypes - array of auction constrainer enabler record types
      Returns:
      the auction constrainer enabler form
      Throws:
      NullArgumentException - auctionConstrainerEnablerRecordTypes is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - unable to get form for requested record types
      Compliance:
      mandatory - This method must be implemented.

    • createAuctionConstrainerEnabler

      AuctionConstrainerEnabler createAuctionConstrainerEnabler(AuctionConstrainerEnablerForm auctionConstrainerEnablerForm) throws OperationFailedException, PermissionDeniedException
      Creates a new AuctionConstrainerEnabler .
      Parameters:
      auctionConstrainerEnablerForm - the form for this AuctionConstrainerEnabler
      Returns:
      the new AuctionConstrainerEnabler
      Throws:
      IllegalStateException - auctionConstrainerEnablerForm already used in a create transaction
      InvalidArgumentException - one or more of the form elements is invalid
      NullArgumentException - auctionConstrainerEnablerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auctionConstrainerEnablerForm did not originate from getAuctionConstrainerEnablerFormForCreate()
      Compliance:
      mandatory - This method must be implemented.

    • canUpdateAuctionConstrainerEnablers

      boolean canUpdateAuctionConstrainerEnablers()
      Tests if this user can update auction constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AuctionConstrainerEnabler will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
      Returns:
      false if AuctionConstrainerEnabler modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainerEnablerFormForUpdate

      AuctionConstrainerEnablerForm getAuctionConstrainerEnablerFormForUpdate(Id auctionConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the auction constrainer enabler form for updating an existing auction constrainer enabler. A new auction constrainer enabler form should be requested for each update transaction.
      Parameters:
      auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler
      Returns:
      the auction constrainer enabler form
      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.

    • updateAuctionConstrainerEnabler

      void updateAuctionConstrainerEnabler(AuctionConstrainerEnablerForm auctionConstrainerEnablerForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing auction constrainer enabler.
      Parameters:
      auctionConstrainerEnablerForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - auctionConstrainerEnablerForm already used in an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - auctionConstrainerEnablerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auctionConstrainerEnablerForm did not originate from getAuctionConstrainerEnablerFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteAuctionConstrainerEnablers

      boolean canDeleteAuctionConstrainerEnablers()
      Tests if this user can delete auction constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AuctionConstrainerEnabler will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
      Returns:
      false if AuctionConstrainerEnabler deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteAuctionConstrainerEnabler

      void deleteAuctionConstrainerEnabler(Id auctionConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Deletes an AuctionConstrainerEnabler .
      Parameters:
      auctionConstrainerEnablerId - the Id of the AuctionConstrainerEnabler to remove
      Throws:
      NotFoundException - auctionConstrainerEnablerId not found
      NullArgumentException - auctionConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageAuctionConstrainerEnablerAliases

      boolean canManageAuctionConstrainerEnablerAliases()
      Tests if this user can manage Id aliases for auction constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
      Returns:
      false if AuctionConstrainerEnabler aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasAuctionConstrainerEnabler

      void aliasAuctionConstrainerEnabler(Id auctionConstrainerEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to an AuctionConstrainerEnabler for the purpose of creating compatibility. The primary Id of the AuctionConstrainerEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another auction constrainer enabler. it is reassigned to the given auction constrainer enabler Id .
      Parameters:
      auctionConstrainerEnablerId - the Id of an AuctionConstrainerEnabler
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - auctionConstrainerEnablerId not found
      NullArgumentException - auctionConstrainerEnablerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.