// Copyright 2012 Google Inc. All Rights Reserved.
//
// Licensed 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 com.google.collide.dto;

import com.google.collide.dto.NodeConflictDto.ConflictHandle;
import com.google.collide.dtogen.shared.RoutingType;
import com.google.collide.dtogen.shared.ServerToClientDto;

/**
 * Message sent to clients to indicate a change in the resolution status of a
 * conflict chunk in a text file.
 *
 */
@RoutingType(type = RoutingTypes.CONFLICTCHUNKRESOLVED)
public interface ConflictChunkResolved extends ServerToClientDto {

  String getFileEditSessionKey();

  /**
   * Array index of the conflict chunk within the file.
   */
  int getConflictChunkIndex();

  /**
   * Whether the conflict chunk is now resolved.
   */
  boolean isResolved();

  /** An opaque handle identifying an out of date conflict */
  ConflictHandle getConflictHandle();
}
