SupplementWaveView.java

/**
 * Copyright 2009 Google Inc.
 *
 * 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 org.waveprotocol.wave.model.supplement;


import org.waveprotocol.wave.model.id.WaveletId;
import org.waveprotocol.wave.model.version.HashedVersion;

import java.util.Map;

/**
 * Defines the aspects of a wave view in which {@link SupplementedWaveImpl}
 * is interested.
 *
 */
// TODO(anorth, hearnden): Replace wavelet ids with string conversation ids.
public interface SupplementWaveView {
  /**
   * @return the ids of all conversational wavelets.
   */
  Iterable<WaveletId> getWavelets();

  /**
   * @return the current version of a wavelet.
   */
  long getVersion(WaveletId id);

  /**
   * @return the signature hash of the specified wavelet
   * at its current version.
   */
  HashedVersion getSignature(WaveletId id);

  /**
   * @param id The id of the wavelet to get blip versions for.
   * @return The version of each blip in the wavelet with id, ignoring blips
   *         which are deleted.
   */
  Map<String, Long> getBlipVersions(WaveletId id);

  /**
   * @return true if the account viewing this wave is listed as an explicit
   *         participant.
   */
  boolean isExplicitParticipant();
}