Record Class TreeStructureConfigContribution

java.lang.Object
java.lang.Record
ch.tocco.nice2.rest.client.api.TreeStructureConfigContribution
public record TreeStructureConfigContribution(String entityName, String treeEndpoint, String relationshipModel, String relationshipChildField, String relationshipParentField, String newNodeTranslationKey, String nodeCreatedTranslationKey, List<String> treeEnabledRelations) extends Record
Contribution for tree structure configuration. Modules contribute this to provide entity-specific tree navigation config to the frontend.

Example: The event module contributes config for Event (relCourse/relModule hierarchy).

  • Constructor Details

    • TreeStructureConfigContribution

      public TreeStructureConfigContribution(String entityName, String treeEndpoint, String relationshipModel, String relationshipChildField, String relationshipParentField, String newNodeTranslationKey, String nodeCreatedTranslationKey, List<String> treeEnabledRelations)
      Creates an instance of a TreeStructureConfigContribution record class.
      Parameters:
      entityName - the value for the entityName record component
      treeEndpoint - the value for the treeEndpoint record component
      relationshipModel - the value for the relationshipModel record component
      relationshipChildField - the value for the relationshipChildField record component
      relationshipParentField - the value for the relationshipParentField record component
      newNodeTranslationKey - the value for the newNodeTranslationKey record component
      nodeCreatedTranslationKey - the value for the nodeCreatedTranslationKey record component
      treeEnabledRelations - the value for the treeEnabledRelations record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • entityName

      public String entityName()
      Returns the value of the entityName record component.
      Returns:
      the value of the entityName record component

    • treeEndpoint

      public String treeEndpoint()
      Returns the value of the treeEndpoint record component.
      Returns:
      the value of the treeEndpoint record component

    • relationshipModel

      public String relationshipModel()
      Returns the value of the relationshipModel record component.
      Returns:
      the value of the relationshipModel record component

    • relationshipChildField

      public String relationshipChildField()
      Returns the value of the relationshipChildField record component.
      Returns:
      the value of the relationshipChildField record component

    • relationshipParentField

      public String relationshipParentField()
      Returns the value of the relationshipParentField record component.
      Returns:
      the value of the relationshipParentField record component

    • newNodeTranslationKey

      public String newNodeTranslationKey()
      Returns the value of the newNodeTranslationKey record component.
      Returns:
      the value of the newNodeTranslationKey record component

    • nodeCreatedTranslationKey

      public String nodeCreatedTranslationKey()
      Returns the value of the nodeCreatedTranslationKey record component.
      Returns:
      the value of the nodeCreatedTranslationKey record component

    • treeEnabledRelations

      public List<String> treeEnabledRelations()
      Returns the value of the treeEnabledRelations record component.
      Returns:
      the value of the treeEnabledRelations record component