Package org.ametys.core.migration.version

Interface Version

All Known Implementing Classes:
AbstractVersion, JcrDataVersion, SqlVersion
public interface Version
Representation of a version Each upgrade create a new version

  • Method Details

    • getVersionHandlerId

      String getVersionHandlerId()
      Get the version handler ID of this version
      Returns:
      The version handler ID of this version

    • getComponentId

      String getComponentId()
      Get the component id
      Returns:
      The component id

    • getVersionNumber

      String getVersionNumber()
      Get the number of the version (null means that initialization is needed)
      Returns:
      The number of the version

    • setVersionNumber

      void setVersionNumber(String number)
      Set the number of the version Should only be used in initialization actions, so the version contains the version to reach, not the version to start (which should be null in the case of initialization)
      Parameters:
      number - number to set for this version

    • getExecutionInstant

      Instant getExecutionInstant()
      Get the time when the version was created
      Returns:
      The time when the version was created

    • setExecutionInstant

      void setExecutionInstant(Instant executionInstant)
      Set the execution date of this version (only to be used when creating a new version after cloning an old version)
      Parameters:
      executionInstant - instant to set

    • getComment

      String getComment()
      Get the comment about this version
      Returns:
      The comment about this version

    • setComment

      void setComment(String comment)
      Change the comment of the version
      Parameters:
      comment - comment to set

    • copyFromActionData

      Version copyFromActionData(ActionData actionData)
      Copy the Version object but only specific fields and componentId
      Parameters:
      actionData - The action data which inside there is the version to copy and the data to keep
      Returns:
      A copy of the Version object

    • addAdditionalValue

      Object addAdditionalValue(String key, Object value)
      Add a parameter that will be replaced in the script with the value
      Parameters:
      key - key to replace
      value - value that will be inserted
      Returns:
      the previous value associated with key, or null if there was no mapping for key.

    • getAdditionalValues

      Map<String,Object> getAdditionalValues()
      Get the map of values to replace in the script
      Returns:
      the map of keys to replace in the script