Record Class CAStockSearchParameters

java.lang.Object
java.lang.Record
com.io7m.cardant.model.CAStockSearchParameters
Record Components:
locationMatch - The locations to include
itemMatch - The items to include
includeOccurrences - The stock occurrences to include
includeDeleted - Whether to include deleted items
pageSize - The page size
All Implemented Interfaces:
CASearchParametersType
public record CAStockSearchParameters(CALocationMatchType locationMatch, CAComparisonExactType<CAItemID> itemMatch, Set<CAStockOccurrenceKind> includeOccurrences, CAIncludeDeleted includeDeleted, long pageSize) extends Record implements CASearchParametersType
The stock search parameters.

  • Constructor Details

    • CAStockSearchParameters

      public CAStockSearchParameters(CALocationMatchType locationMatch, CAComparisonExactType<CAItemID> itemMatch, Set<CAStockOccurrenceKind> includeOccurrences, CAIncludeDeleted includeDeleted, long pageSize)
      The stock search parameters.
      Parameters:
      locationMatch - The locations to include
      itemMatch - The items to include
      includeOccurrences - The stock occurrences to include
      includeDeleted - Whether to include deleted items
      pageSize - The page size

  • 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 the compare method from their corresponding wrapper classes.
      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.

    • locationMatch

      public CALocationMatchType locationMatch()
      Returns the value of the locationMatch record component.
      Returns:
      the value of the locationMatch record component

    • itemMatch

      public CAComparisonExactType<CAItemID> itemMatch()
      Returns the value of the itemMatch record component.
      Returns:
      the value of the itemMatch record component

    • includeOccurrences

      public Set<CAStockOccurrenceKind> includeOccurrences()
      Returns the value of the includeOccurrences record component.
      Returns:
      the value of the includeOccurrences record component

    • includeDeleted

      public CAIncludeDeleted includeDeleted()
      Returns the value of the includeDeleted record component.
      Returns:
      the value of the includeDeleted record component

    • pageSize

      public long pageSize()
      Returns the value of the pageSize record component.
      Specified by:
      pageSize in interface CASearchParametersType
      Returns:
      the value of the pageSize record component