Interface AuctionProcessorAdminSession

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

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

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

    • canCreateAuctionProcessor

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

    • canCreateAuctionProcessorWithRecordTypes

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

    • getAuctionProcessorFormForCreate

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

    • createAuctionProcessor

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

    • canUpdateAuctionProcessors

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

    • getAuctionProcessorFormForUpdate

      AuctionProcessorForm getAuctionProcessorFormForUpdate(Id auctionProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the auction processor form for updating an existing auction processor. A new auction processor form should be requested for each update transaction.
      Parameters:
      auctionProcessorId - the Id of the AuctionProcessor
      Returns:
      the auction processor form
      Throws:
      NotFoundException - auctionProcessorId is not found
      NullArgumentException - auctionProcessorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateAuctionProcessor

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

    • canDeleteAuctionProcessors

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

    • deleteAuctionProcessor

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

    • canManageAuctionProcessorAliases

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

    • aliasAuctionProcessor

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