Interface AuctionConstrainerAdminSession

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

This session creates and removes auction constrainers. The data for create and update is provided via the AuctionConstrainerForm .

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

    • canCreateAuctionConstrainer

      boolean canCreateAuctionConstrainer()
      Tests if this user can create auction constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an AuctionConstrainer 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 AuctionConstrainer creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateAuctionConstrainerWithRecordTypes

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

    • getAuctionConstrainerFormForCreate

      AuctionConstrainerForm getAuctionConstrainerFormForCreate(Type[] auctionConstrainerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the auction constrainer form for creating new auction constrainers. A new form should be requested for each create transaction.
      Parameters:
      auctionConstrainerRecordTypes - array of auction constrainer record types
      Returns:
      the auction constrainer form
      Throws:
      NullArgumentException - auctionConstrainerRecordTypes 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.

    • createAuctionConstrainer

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

    • canUpdateAuctionConstrainers

      boolean canUpdateAuctionConstrainers()
      Tests if this user can update auction constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AuctionConstrainer 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 AuctionConstrainer modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAuctionConstrainerFormForUpdate

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

    • updateAuctionConstrainer

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

    • canDeleteAuctionConstrainers

      boolean canDeleteAuctionConstrainers()
      Tests if this user can delete auction constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AuctionConstrainer 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 AuctionConstrainer deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteAuctionConstrainer

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

    • canManageAuctionConstrainerAliases

      boolean canManageAuctionConstrainerAliases()
      Tests if this user can manage Id aliases for auction constrainers. 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 AuctionConstrainer aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasAuctionConstrainer

      void aliasAuctionConstrainer(Id auctionConstrainerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to an AuctionConstrainer for the purpose of creating compatibility. The primary Id of the AuctionConstrainer 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. it is reassigned to the given auction constrainer Id .
      Parameters:
      auctionConstrainerId - the Id of an AuctionConstrainer
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - auctionConstrainerId not found
      NullArgumentException - auctionConstrainerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.