Package se.conciliate.extensions.publish.custom.step

Interface ConfigStepUpdateReferences

All Superinterfaces:
ConfigStep
public interface ConfigStepUpdateReferences extends ConfigStep
Updates the created XML files with information that could not be added before all models have been published, such as relations from symbols to other symbols, which is dependent on all the models where the symbol is used. type: post-step

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCopiedDocsTarget()
    Returns the target where copied documents are published, or null if no copied documents are published by this publish.
    List<Long>
    getCustomRelationIds()
    Returns the ID:s of any custom relations that should be included in the publish.
    String
    getDocumentsTarget()
    Returns the target where documents are published, or null if no documents are published by this publish.
    String
    getInternalDocsTarget()
    Returns the target where internal documents are published, or null if no models are published by this publish.
    String
    getListsTarget()
    Returns the target where lists are published, or null if no lists are published by this publish.
    String
    getMenuTarget()
    Returns the target where menu XML are published, or null if no menu XML is published by this publish.
    List<Long>
    getModelCustomRelationIds()
    Returns the ID:s of any custom relations that should be included in the publish.
    String
    getModelsTarget()
    Returns the target where models are published, or null if no models are published by this publish.
    String
    getSearchIndexTarget()
    Returns the target where the search index is published, or null if no search index is published by this publish.
    String
    getSymbolsTarget()
    Returns the target where symbols are published, or null if no symbols are published by this publish.
    String
    getTargetRelURL()
    Returns the relative URL to the target directory.

  • Method Details

    • getModelsTarget

      String getModelsTarget()
      Returns the target where models are published, or null if no models are published by this publish.
      Returns:
      the target where models are published, or null if no models are published by this publish.

    • getSymbolsTarget

      String getSymbolsTarget()
      Returns the target where symbols are published, or null if no symbols are published by this publish.
      Returns:
      the target where symbols are published, or null if no symbols are published by this publish.

    • getDocumentsTarget

      String getDocumentsTarget()
      Returns the target where documents are published, or null if no documents are published by this publish.
      Returns:
      the target where documents are published, or null if no documents are published by this publish.

    • getListsTarget

      String getListsTarget()
      Returns the target where lists are published, or null if no lists are published by this publish.
      Returns:
      the target where lists are published, or null if no lists are published by this publish.

    • getMenuTarget

      String getMenuTarget()
      Returns the target where menu XML are published, or null if no menu XML is published by this publish.
      Returns:
      the target where menu XML are published, or null if no menu XML is published by this publish.

    • getSearchIndexTarget

      String getSearchIndexTarget()
      Returns the target where the search index is published, or null if no search index is published by this publish.
      Returns:
      the target where the search index is published, or null * if no search index is published by this publish.

    • getCopiedDocsTarget

      String getCopiedDocsTarget()
      Returns the target where copied documents are published, or null if no copied documents are published by this publish. Copied documents are documents that have the "copy-on-publish" property set, and that are copied from the source when publishing.
      Returns:
      the target where copied documents are published, or null if no copied documents are published by this publish.

    • getInternalDocsTarget

      String getInternalDocsTarget()
      Returns the target where internal documents are published, or null if no models are published by this publish. Internal documents are documents with content created in the 2c8 Modeling Tool editor.
      Returns:
      the target where internal documents are published, or null if no models are published by this publish.

    • getCustomRelationIds

      List<Long> getCustomRelationIds()
      Returns the ID:s of any custom relations that should be included in the publish. These are custom relations with symbols as context.
      Returns:
      the ID:s of any custom relations that should be included in the publish.

    • getModelCustomRelationIds

      List<Long> getModelCustomRelationIds()
      Returns the ID:s of any custom relations that should be included in the publish. These are custom relations with models as context.
      Returns:
      the ID:s of any custom relations that should be included in the publish.

    • getTargetRelURL

      String getTargetRelURL()
      Returns the relative URL to the target directory. We write the files to a temp directory called target. Then we rename the temp directory, so anyone trying to link to the target needs to have a relative URL to use. Example: target=pages/javascript/models-js target-rel-url=pages-151217.0904/javascript/models-js
      Returns:
      Returns the relative URL to the target directory.