org.hyperledger.fabric.shim.ledger.QueryResultsIteratorWithMetadata Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fabric-chaincode-shim Show documentation

Hyperledger Fabric Java Chaincode Shim

There is a newer version: 2.5.3

Show newest version

/*
 * Copyright 2019 IBM All Rights Reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

package org.hyperledger.fabric.shim.ledger;

import org.hyperledger.fabric.protos.peer.QueryResponseMetadata;

/**
 * QueryResultsIteratorWithMetadata allows a chaincode to iterate over a set of
 * key/value pairs returned by range, execute and history queries. In addition,
 * it store
 * {@link org.hyperledger.fabric.protos.peer.QueryResponseMetadata},
 * returned by pagination range queries
 *
 * @param  the type of elements returned by the iterator
 */
public interface QueryResultsIteratorWithMetadata extends Iterable, AutoCloseable {
    /**
     *
     * @return Query Metadata
     */
    QueryResponseMetadata getMetadata();
}