Interface ConfigStepLists

All Superinterfaces:
ConfigStep

public interface ConfigStepLists extends ConfigStep
Creates an XML containing the result of executing lists. Only models, documents and symbols included in the publish will be included in the result. type: post-step Example XML:

  <lists>
      <target>xml/lists/list-%s.xml</target>
      <list-id>7</list-id>
      <list-id>12</list-id>
  </lists>
 
  • Method Details

    • getTarget

      String getTarget()
      The target name of the XMl files created for the list. The target name should contain a wildcard "%s" somewhere where the ID of the list will be inserted. XML tag: "target"
      Returns:
      The target name of the XMl files created for the list. The
    • setTarget

      void setTarget(String target)
    • getLists

      Set<Long> getLists()
      The ID:s of the lists to generate results for. XML tag: "list-id"
      Returns:
      The ID:s of the lists to generate results for.
    • setLists

      void setLists(Set<Long> lists)
    • isShowModelPrefix

      boolean isShowModelPrefix()
    • isShowObjectPrefix

      boolean isShowObjectPrefix()
    • isShowDocumentPrefix

      boolean isShowDocumentPrefix()
    • isGeneratePDF

      boolean isGeneratePDF()
    • isGenerateXLS

      boolean isGenerateXLS()
    • isExpandXLS

      boolean isExpandXLS()
    • getTargetRelURL

      String getTargetRelURL()