/*
 * 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 accord.api;

import javax.annotation.Nullable;

import accord.primitives.Participants;
import accord.primitives.Ranges;
import accord.primitives.Seekables;
import accord.primitives.Timestamp;

/**
 * A client-defined update operation (the write equivalent of a query).
 * Takes as input the data returned by {@code Read}, and returns a {@code Write}
 * representing new information to distributed to each shard's stores.
 *
 * Update will be invoked after Query at a coordinator
 */
public interface Update extends Sliceable<Update>
{
    Seekables<?, ?> keys();
    // null is provided only if nothing was read
    Write apply(Timestamp executeAt, @Nullable Data data);
    Update slice(Ranges ranges);
    Update intersecting(Participants<?> participants);
    Update merge(Update other);

}
