Class FlatArticle

  • All Implemented Interfaces:
    java.lang.Comparable<FlatArticle>


    public class FlatArticle
    extends java.lang.Object
    implements java.lang.Comparable<FlatArticle>
    This is a model class for a FlatArticle object which contains an Article object, its relevant Section object and its relevant Category object for ease of use. It will be created by the HelpCenterProvider.

    Created by Zendesk.

    • Constructor Detail

      • FlatArticle

        public FlatArticle(Category category,
                           Section section,
                           Article article)
        Creates an instance of FlatArticle from the given category, section and article
        Parameters:
        category - The category which the article belongs to
        section - The section which the article belongs to
        article - The article to wrap in this FlatArticle
    • Method Detail

      • getCategory

        public Category getCategory()
        Gets the category which this article belongs to
        Returns:
        the category which this article belongs to
      • getSection

        public Section getSection()
        Gets the section which this article belongs to
        Returns:
        the section which this article belongs to
      • getArticle

        public Article getArticle()
        The article object which this flat article is wrapping
        Returns:
        article object which this flat article is wrapping
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • compareTo

        public int compareTo(FlatArticle flatArticle)
        Specified by:
        compareTo in interface java.lang.Comparable<FlatArticle>