Class CodeScanStatisticsSearchRequest

java.lang.Object
com.persequor.saga.modules.dpp.sdk.CodeScanStatisticsSearchRequest

public class CodeScanStatisticsSearchRequest extends Object
  • Method Details

    • build

      public static CodeScanStatisticsSearchRequest build()
    • getOffset

      public Integer getOffset()
      Get the offset for the statistics query.
      Returns:
      the offset, or null if no offset is set
    • setOffset

      public CodeScanStatisticsSearchRequest setOffset(Integer offset)
      Set the offset for the statistics query.

      Offset is the number of items to skip before starting to collect the result set.

      Parameters:
      offset - number of items to skip, or null to not skip any items
      Returns:
      this, for chaining
    • getLimit

      public Integer getLimit()
      Get the limit for the statistics query.
      Returns:
      the limit, or null if no limit is set
    • setLimit

      public CodeScanStatisticsSearchRequest setLimit(Integer limit)
      Set the limit for the statistics query.

      Limit is the maximum number of items to return.

      If no limit is set the database provider may decide how many items to return, but should attempt to return all items on a best-effort basis.

      Parameters:
      limit - maximum number of items to return, or null to not limit the number of items
      Returns:
      this, for chaining
    • isIncludeUnknownCodes

      public boolean isIncludeUnknownCodes()
      Get whether to include unknown codes in the statistics query.
      Returns:
      true if unknown codes should be included, false otherwise
    • setIncludeUnknownCodes

      public CodeScanStatisticsSearchRequest setIncludeUnknownCodes(boolean includeUnknownCodes)
      Set whether to include unknown codes in the statistics query.

      Unknown codes are codes that do not have any item data associated with them.

      Parameters:
      includeUnknownCodes - true to include unknown codes, false to exclude them
      Returns:
      this, for chaining