Package org.praxisplatform.uischema.surface

Record Class SurfaceDefinition

java.lang.Object
java.lang.Record
org.praxisplatform.uischema.surface.SurfaceDefinition
public record SurfaceDefinition(String id, String resourceKey, String resourcePath, String group, SurfaceKind kind, SurfaceScope scope, String title, String description, String intent, String schemaType, CanonicalOperationRef operation, CanonicalSchemaRef schema, int order, List<String> requiredAuthorities, List<String> allowedStates, List<String> tags) extends Record
Definicao estavel de uma surface descoberta a partir de operacoes reais do recurso.

  • Constructor Details

    • SurfaceDefinition

      public SurfaceDefinition(String id, String resourceKey, String resourcePath, String group, SurfaceKind kind, SurfaceScope scope, String title, String description, String intent, String schemaType, CanonicalOperationRef operation, CanonicalSchemaRef schema, int order, List<String> requiredAuthorities, List<String> allowedStates, List<String> tags)
      Creates an instance of a SurfaceDefinition record class.
      Parameters:
      id - the value for the id record component
      resourceKey - the value for the resourceKey record component
      resourcePath - the value for the resourcePath record component
      group - the value for the group record component
      kind - the value for the kind record component
      scope - the value for the scope record component
      title - the value for the title record component
      description - the value for the description record component
      intent - the value for the intent record component
      schemaType - the value for the schemaType record component
      operation - the value for the operation record component
      schema - the value for the schema record component
      order - the value for the order record component
      requiredAuthorities - the value for the requiredAuthorities record component
      allowedStates - the value for the allowedStates record component
      tags - the value for the tags 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • id

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

    • resourceKey

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

    • resourcePath

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

    • group

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

    • kind

      public SurfaceKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • scope

      public SurfaceScope scope()
      Returns the value of the scope record component.
      Returns:
      the value of the scope record component

    • title

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

    • description

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

    • intent

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

    • schemaType

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

    • operation

      public CanonicalOperationRef operation()
      Returns the value of the operation record component.
      Returns:
      the value of the operation record component

    • schema

      public CanonicalSchemaRef schema()
      Returns the value of the schema record component.
      Returns:
      the value of the schema record component

    • order

      public int order()
      Returns the value of the order record component.
      Returns:
      the value of the order record component

    • requiredAuthorities

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

    • allowedStates

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

    • tags

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