Package org.eclipse.keypop.calypso.card.transaction

Interface SearchCommandData

public interface SearchCommandData
Contains the input/output data of the TransactionManager.prepareSearchRecords(SearchCommandData) method.

An instance of this interface can be obtained via the method CalypsoCardApiFactory.createSearchCommandData().

Since:
1.1.0

  • Method Details

    • setSfi

      SearchCommandData setSfi(byte sfi)
      Sets the SFI of the EF in which the search is to be performed.
      Parameters:
      sfi - The SFI of the EF.
      Returns:
      The current instance.
      Since:
      1.1.0

    • startAtRecord

      SearchCommandData startAtRecord(int recordNumber)
      Sets the number of the record where the search should begin.

      By default, the search will begin from the first record.

      Parameters:
      recordNumber - The number of the record where the search should begin.
      Returns:
      The current instance.
      Since:
      1.1.0

    • setOffset

      SearchCommandData setOffset(int offset)
      Sets the offset in number of bytes from which the analysis should be performed within a record.

      By default, the analysis will start at the beginning of the record (offset 0).

      Parameters:
      offset - The offset.
      Returns:
      The current instance.
      Since:
      1.1.0

    • enableRepeatedOffset

      SearchCommandData enableRepeatedOffset()
      Allows the command to analyze the data present at the given offset, and repeatedly at each following offset, until the end of the record is reached. The last offset is less or equal than ((record size) − (length of the search data)).
      Returns:
      The current instance.
      Since:
      1.1.0

    • setSearchData

      SearchCommandData setSearchData(byte[] data)
      Sets the data to search.
      Parameters:
      data - The data to search.
      Returns:
      The current instance.
      Since:
      1.1.0

    • setMask

      SearchCommandData setMask(byte[] mask)
      Sets the mask of bits to take into account during the comparison (padded right with FFh if absent or incomplete).

      Requirement: The length of the mask must be less or equal than the length of the data to search.

      Parameters:
      mask - The mask.
      Returns:
      The current instance.
      Since:
      1.1.0

    • fetchFirstMatchingResult

      SearchCommandData fetchFirstMatchingResult()
      Requests to fetch the content of the first matching record into the CalypsoCard.
      Returns:
      The current instance.
      Since:
      1.1.0

    • getMatchingRecordNumbers

      List<Integer> getMatchingRecordNumbers()
      Returns a list containing the numbers of the records who has matched.
      Returns:
      An empty list if no record has matched or if the command has not yet been processed.
      Since:
      1.1.0