Package fr.gouv.vitam.storage.engine.common.referential

# Interface StorageOfferProvider

public interface StorageOfferProvider
This interface aims at providing a set of method that are common with no concerns of the offer configuration persistence implementation (ie: implementation could be Filesystem, Database...)

- ## Method Summary

  Modifier and Type
  Method
  Description
  `StorageOffer`
  `getStorageOffer(String idOffer)`
  Retrieve an offer full configuration by its id
  `StorageOffer`
  `getStorageOffer(String idOffer, boolean includeDisabled)`
  Retrieve an offer full configuration by its id, may include disabled one ( `ActivationStatus.INACTIVE`)

- ## Method Details

  - ### getStorageOffer

    StorageOffer getStorageOffer(String idOffer) throws StorageException
    Retrieve an offer full configuration by its id
    Parameters:
      `idOffer` - the id of the storage offer to retrieve
    Returns:
      an object representation of a storage offer
    Throws:
      `StorageException` - if any unwanted technical issue happens

  - ### getStorageOffer

    StorageOffer getStorageOffer(String idOffer, boolean includeDisabled) throws StorageException
    Retrieve an offer full configuration by its id, may include disabled one ( `ActivationStatus.INACTIVE`)
    Parameters:
      `idOffer` - the id of the storage offer to retrieve
      `includeDisabled` - whether to include offer with inactive state
    Returns:
      an object representation of a storage offer
    Throws:
      `StorageException` - if any unwanted technical issue happens