/*
 * 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.gobblin.configuration;

/**
 * A {@link FunctionalInterface} to return {@link CombinedWorkUnitAndDatasetState}.
 */
@FunctionalInterface
public interface CombinedWorkUnitAndDatasetStateFunctional {
  /**
   *
   * @param datasetUrn the dataset urn
   * @return an instance {@link CombinedWorkUnitAndDatasetState}. If datasetUrn is null or empty, then return latest {@link WorkUnitState}s and DatasetStates of all datasetUrns in the state store; else return the previous {@link WorkUnitState} and the DatasetState of the specified datasetUrn.
   * @throws Exception the exception
   */
  public CombinedWorkUnitAndDatasetState getCombinedWorkUnitAndDatasetState(String datasetUrn)
      throws Exception;
}
