Package org.praxisplatform.uischema.options

Record Class OptionSourcePolicy

java.lang.Object
java.lang.Record
org.praxisplatform.uischema.options.OptionSourcePolicy
public record OptionSourcePolicy(boolean excludeSelfField, boolean allowSearch, String searchMode, int minSearchChars, int defaultPageSize, int maxPageSize, boolean allowIncludeIds, boolean cacheable, String defaultSort) extends Record
Public execution policy for a registered option source.

  • Constructor Summary

    Constructors
    Constructor
    Description
    OptionSourcePolicy(boolean excludeSelfField, boolean allowSearch, String searchMode, int minSearchChars, int defaultPageSize, int maxPageSize, boolean allowIncludeIds, boolean cacheable, String defaultSort)
    Creates an instance of a OptionSourcePolicy record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    allowIncludeIds()
    Returns the value of the allowIncludeIds record component.
    boolean
    allowSearch()
    Returns the value of the allowSearch record component.
    boolean
    cacheable()
    Returns the value of the cacheable record component.
    int
    defaultPageSize()
    Returns the value of the defaultPageSize record component.
    static OptionSourcePolicy
    defaults()
     
    String
    defaultSort()
    Returns the value of the defaultSort record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    excludeSelfField()
    Returns the value of the excludeSelfField record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    maxPageSize()
    Returns the value of the maxPageSize record component.
    int
    minSearchChars()
    Returns the value of the minSearchChars record component.
    String
    searchMode()
    Returns the value of the searchMode record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • OptionSourcePolicy

      public OptionSourcePolicy(boolean excludeSelfField, boolean allowSearch, String searchMode, int minSearchChars, int defaultPageSize, int maxPageSize, boolean allowIncludeIds, boolean cacheable, String defaultSort)
      Creates an instance of a OptionSourcePolicy record class.
      Parameters:
      excludeSelfField - the value for the excludeSelfField record component
      allowSearch - the value for the allowSearch record component
      searchMode - the value for the searchMode record component
      minSearchChars - the value for the minSearchChars record component
      defaultPageSize - the value for the defaultPageSize record component
      maxPageSize - the value for the maxPageSize record component
      allowIncludeIds - the value for the allowIncludeIds record component
      cacheable - the value for the cacheable record component
      defaultSort - the value for the defaultSort record component

  • Method Details

    • defaults

      public static OptionSourcePolicy defaults()

    • 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.

    • excludeSelfField

      public boolean excludeSelfField()
      Returns the value of the excludeSelfField record component.
      Returns:
      the value of the excludeSelfField record component

    • allowSearch

      public boolean allowSearch()
      Returns the value of the allowSearch record component.
      Returns:
      the value of the allowSearch record component

    • searchMode

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

    • minSearchChars

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

    • defaultPageSize

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

    • maxPageSize

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

    • allowIncludeIds

      public boolean allowIncludeIds()
      Returns the value of the allowIncludeIds record component.
      Returns:
      the value of the allowIncludeIds record component

    • cacheable

      public boolean cacheable()
      Returns the value of the cacheable record component.
      Returns:
      the value of the cacheable record component

    • defaultSort

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