Interface ISpecDocumentation


public interface ISpecDocumentation
Interface to read/write from the Specs' ProjectDocumentation sheet.
Author:
Ivan Prieto Barreiro
  • Method Details

    • getProjectName

      String getProjectName()
      Get the project name.
      Returns:
    • setProjectName

      void setProjectName(String name)
      Set the project name.
      Parameters:
      name - The project name.
    • getApplicationName

      String getApplicationName()
      Get the application name.
      Returns:
    • setApplicationName

      void setApplicationName(String name)
      Set the application name.
      Parameters:
      name - The application name.
    • getProjectDescription

      String getProjectDescription()
      Get the project description.
      Returns:
    • setProjectDescription

      void setProjectDescription(String desc)
      Set the project description.
      Parameters:
      desc - The project description.
    • getProjectOwner

      String getProjectOwner()
      Get the project owner alias.
      Returns:
    • setProjectOwner

      void setProjectOwner(String owner)
      Set the project owner alias.
      Parameters:
      owner - Project owner alias.
    • getFaqLink

      String getFaqLink()
      Get the FAQ URL.
      Returns:
    • setFaqLink

      void setFaqLink(String faqLink)
      Set FAQ URL
      Parameters:
      faqLink - URL
    • getObjectDescriptionsLink

      String getObjectDescriptionsLink()
      Get the object descriptions URL.
      Returns:
    • setObjectDescriptionsLink

      void setObjectDescriptionsLink(String objectDescriptionsLink)
      Set object descriptions URL.
      Parameters:
      objectDescriptionsLink - url
    • getSpecChanges

      List<ISpecChange> getSpecChanges()
      Get the list of changes in the specs.
      Returns:
    • newSpecChange

      ISpecChange newSpecChange()
      Create a new specs change.
      Returns:
    • addSpecChange

      void addSpecChange(ISpecChange change)
      Add a new change to the specs.
      Parameters:
      change -
    • getSpecsVersion

      String getSpecsVersion()
      Get the specs version.
      Returns:
      The version number of the last spec changes or the empty string if there are no changes.