nifi/nifi-api/src/main/java/org/apache/nifi/provenance/search/QueryResult.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.nifi.provenance.search;

import java.util.Date;
import java.util.List;

import org.apache.nifi.provenance.StoredProvenanceEvent;

public interface QueryResult {

    /**
     * Returns the Provenance events that match the query (up to the limit
     * specified in the query)
     *
     * @return
     */
    List<StoredProvenanceEvent> getMatchingEvents();

    /**
     * Returns the total number of Provenance Events that hit
     *
     * @return
     */
    long getTotalHitCount();

    /**
     * Returns the number of milliseconds the query took to run
     *
     * @return
     */
    long getQueryTime();

    /**
     * Returns the date at which this QueryResult will expire
     *
     * @return
     */
    Date getExpiration();

    /**
     * If an error occurred while computing the lineage, this will return the
     * serialized error; otherwise, returns <code>null</code>.
     *
     * @return
     */
    String getError();

    /**
     * returns an integer between 0 and 100 (inclusive) that indicates what
     * percentage of completion the query has reached
     *
     * @return
     */
    int getPercentComplete();

    /**
     * Indicates whether or not the query has finished running
     *
     * @return
     */
    boolean isFinished();
}