Class Domain

  • All Implemented Interfaces:
    java.io.Serializable

    public class Domain
    extends java.lang.Object
    implements java.io.Serializable
    Domain with hierarchy
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      Domain()
      Default constructor for root domain
      Domain​(java.lang.String id, java.lang.String name, boolean hasHome, java.lang.String homeView, java.lang.String icon, int order)
      Constructor with domain definition
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addChild​(Domain child)
      Add a child to domain
      void enableHome​(boolean b)
      Enable home page
      java.util.List<Domain> getChildren()
      Domain children
      java.lang.String getDisplay​(java.lang.String lang)
      Domain label in user language
      static java.lang.String getDomainId​(java.lang.String name)
      Returns domain ID for specified name
      java.lang.String getHomePage()
      Get the domain home name
      java.lang.String getIcon()
      Get the domain icon
      java.lang.String getId()
      Get the domain Id
      java.lang.String getName()
      Get the domain name
      int getOrder()
      Get domain order
      Domain getParent()
      Parent domain
      boolean hasHome()
      Has home page?
      void setDisplay​(java.lang.String lang, java.lang.String label)
      Set the domain translation
      void setHomePage​(java.lang.String home)
      Set the home name
      void setIcon​(java.lang.String icon)
      Set the icon name
      void setOrder​(int order)
      Set domain order
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Domain

        public Domain()
        Default constructor for root domain
      • Domain

        public Domain​(java.lang.String id,
                      java.lang.String name,
                      boolean hasHome,
                      java.lang.String homeView,
                      java.lang.String icon,
                      int order)
        Constructor with domain definition
        Parameters:
        id - Domain Id
        name - Domain name
        hasHome - Domain has a home page?
        homeView - Optional home page name (default domain index page)
        icon - Optional icon name
        order - Domain order
    • Method Detail

      • getDomainId

        public static java.lang.String getDomainId​(java.lang.String name)
        Returns domain ID for specified name
        Parameters:
        name - Domain name
        Returns:
        Domain ID
      • getId

        public java.lang.String getId()
        Get the domain Id
        Returns:
        Id
      • getName

        public java.lang.String getName()
        Get the domain name
        Returns:
        Name
      • getIcon

        public java.lang.String getIcon()
        Get the domain icon
        Returns:
        Icon or null
      • setIcon

        public void setIcon​(java.lang.String icon)
        Set the icon name
        Parameters:
        icon - Icon name
      • getHomePage

        public java.lang.String getHomePage()
        Get the domain home name
        Returns:
        View name or null
      • setHomePage

        public void setHomePage​(java.lang.String home)
        Set the home name
        Parameters:
        home - Home name
      • hasHome

        public boolean hasHome()
        Has home page?
        Returns:
        has home page?
      • enableHome

        public void enableHome​(boolean b)
        Enable home page
        Parameters:
        b -
      • getOrder

        public int getOrder()
        Get domain order
        Returns:
        order
      • setOrder

        public void setOrder​(int order)
        Set domain order
        Parameters:
        order - order
      • setDisplay

        public void setDisplay​(java.lang.String lang,
                               java.lang.String label)
        Set the domain translation
        Parameters:
        lang - Language
        label - Label
      • getDisplay

        public java.lang.String getDisplay​(java.lang.String lang)
        Domain label in user language
        Parameters:
        lang - User language
        Returns:
        Domain label or name if unknown
      • getParent

        public Domain getParent()
        Parent domain
        Returns:
        Domain or null
      • getChildren

        public java.util.List<Domain> getChildren()
        Domain children
        Returns:
        list or null
      • addChild

        public void addChild​(Domain child)
        Add a child to domain
        Parameters:
        child - Domain to append to children