package gw.exportimport

uses gw.exportimport.validation.ImportValidationResult

uses java.util.Set
uses java.util.Map
uses java.util.List

/**
 * Interface that defines all metadata required for import.
 */
interface ImportMetaData {

  /**
   * The {@link EntityInfo} including the {@link KeyableBean} to be imported
   */
  property get EntityInfo() : EntityInfo< KeyableBean >

  /**
   * The used language of the data (used for localized import)
   */
  property get LanguageType() : LanguageType

  /**
   * The used language of the data (used for localized import)
   */
  property get LocaleType() : LocaleType

  /**
   * All {@link ColumnInfo} for all columns
   */
  property get HeaderInfo() : List<ColumnInfo>

  /**
   * The import validation result for both steps of the import process.
   */
  property get ValidationResult() : ImportValidationResult

  /**
   * Returns the EntityType's {@link ColumnInfo}'s required for import that are
   * not present in the HeaderInfo
   */
  property get MissingColumnInfos() : Set<ColumnInfo>

  /**
   * Returns the PeriodID of the period from which the data is exported from
   */
  property get PeriodID() : String

  /**
   * Returns the JobID of the job from which the data is exported from
   */
  property get JobID() : String

  /**
   * Returns <code>true</code> if the data is being imported from a template excel file
   */
  property get Template() : boolean

  /**
   * Log a created parent entity by its Public ID for later access.
   */
  function setNewParentEntityByPublicID(publicID : String, parentEntity : KeyableBean)

  /**
   * Return whether a created parent entity with the specified Public ID
   *    has been logged.
   */
  function hasNewParentEntityWithPublicID(publicID : String) : boolean

  /**
   * Return a created parent entity by its specified Public ID.
   *
   * @param publicID - created parent entity public ID
   * @returns the created parent entity logged by the specified public ID
   */
  function getNewParentEntityByPublicID(publicID : String) : KeyableBean

  /**
   * Change state to test mode.
   */
  function setTest()

  /**
   * Restore the state to the normal (non-test) import mode.
   */
  function setImport()
}