core/api/src/main/java/org/onlab/onos/net/flow/BatchOperationResult.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.onlab.onos.net.flow;

import java.util.Set;

/**
 * Interface capturing the result of a batch operation.
 *
 */
public interface BatchOperationResult<T> {

    /**
     * Returns whether the operation was successful.
     * @return true if successful, false otherwise
     */
    boolean isSuccess();

    /**
     * Obtains a set of items which failed.
     * @return a set of failures
     */
    Set<T> failedItems();

}