Package com.polarion.subterra.base.data.model

Interface ICodeType

All Superinterfaces:
IType
public interface ICodeType extends IType
Interface for types to use code mirror
Since:
3.8.3

  • Method Details

    • getEditorProperties

      @NotNull Map<String,String> getEditorProperties()

    • getCodeTypeId

      @NotNull String getCodeTypeId()

    • transformForSave

      @Nullable Text transformForSave(@Nullable Text value, @NotNull IContextId ctxId)
      It is possible to save the value of this field type in a different format than what is visible in the editor. E.g. the "value" parameter contains text with a reference to another Work Item. That reference is saved as the workitem id in the repository, but anywhere above the persistence layer, the reference is seen as the title and the id of the Work Item.
      Parameters:
      value - - The field value visible in the editor.
      ctxId - - The context of the feature model. Can be the current context or the context where the container document, for the Work Item containing the field, is branched from.
      Returns:
      the text that will be saved in the repository.
      Since:
      3.9.1

    • transformForEditor

      @Nullable Text transformForEditor(@Nullable Text value, @Nullable String revision, @NotNull IContextId ctxId)
      It is possible to display the value of a field of this type in a different format than what it is saved. E.g. the "value" parameter contains text with a reference to another Work Item. This reference is saved as the workitem id in the repository, but anywhere above the persistence layer, the reference is seen as the title and the id of the Work Item.
      Parameters:
      value - - The field value that is persisted in repository.
      ctxId - - The context of the feature model. Can be the current context or the context where the container document, for the Work Item containing the field, is branched from.
      Returns:
      the text that will be passed to the layers above the persistence layer. (Like the UI).
      Since:
      3.9.1