Class Group


  • public class Group
    extends java.lang.Object
    Provides descriptive information about a user-defined group.
    • Constructor Summary

      Constructors 
      Constructor Description
      Group​(java.lang.String id, java.lang.String name)
      Constructs a Group with all required attributes.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getId()
      Returns the unique identifier for the group.
      java.lang.String getName()
      Returns the name of the group for display.
      java.lang.String getParentGroupId()
      Returns the unique identifier for the group's parent group, or null if the group has no parent group.
      java.util.Map<java.lang.String,​java.lang.String> getTranslatedName()
      Returns the translated names of this group as a Map where the key is the language and the value is the translated name of the group (e.g.
      Group setParentGroupId​(java.lang.String parentGroupId)
      Sets the unique identifier for the group's parent group, or null if the group has no parent group.
      Group setTranslatedName​(java.util.Map<java.lang.String,​java.lang.String> translatedName)
      Sets the translated names of this group as a Map where the key is the language and the value is the translated name of the group (e.g.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

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

      • Group

        public Group​(java.lang.String id,
                     java.lang.String name)
        Constructs a Group with all required attributes. Optional attributes should be provided by calling set methods.

        A Group must provide the following attributes:

        • id - unique identifier for the group
        • name - name of the group for display
        Parameters:
        id - unique identifier for the group
        name - name of the group for display
    • Method Detail

      • getId

        public java.lang.String getId()
        Returns the unique identifier for the group.
        Returns:
        the unique identifier for the group
      • getName

        public java.lang.String getName()
        Returns the name of the group for display.
        Returns:
        the name of the group for display
      • getTranslatedName

        public java.util.Map<java.lang.String,​java.lang.String> getTranslatedName()
        Returns the translated names of this group as a Map where the key is the language and the value is the translated name of the group (e.g. "en", "GroupA"), or null if there are no translations provided for this group name. This will always be null for a user-defined group.

        Default : null (no translations provided)

        Returns:
        the translated names of this group
      • getParentGroupId

        public java.lang.String getParentGroupId()
        Returns the unique identifier for the group's parent group, or null if the group has no parent group.

        Default: null (no parent group)

        Returns:
        the unique identifier for the group's parent group, or null if the group has no parent group
      • setTranslatedName

        public Group setTranslatedName​(java.util.Map<java.lang.String,​java.lang.String> translatedName)
        Sets the translated names of this group as a Map where the key is the language and the value is the translated name of the group (e.g. "en", "GroupA"), or null if there are no translations provided for this group name. This will always be null for a user-defined group.

        Default : null (no translations provided)

        Parameters:
        translatedName - the translated names of the group
        Returns:
        a reference to this object
      • setParentGroupId

        public Group setParentGroupId​(java.lang.String parentGroupId)
        Sets the unique identifier for the group's parent group, or null if the group has no parent group.

        Default: null (no parent group)

        Parameters:
        parentGroupId - the unique identifier for the group's parent group, or null if the group has no parent group
        Returns:
        a reference to this object
      • toString

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