// 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;

/**
 * Represents a participant in a Workspace session.
 * 
 * <p>
 * The participant does not include any private information about the user, just
 * the user's ID. Each client must request the participants UserInfo separately
 * so the frontend can customize the results based on the participants privacy
 * settings.
 */
// TODO: Rename to ParticipantInfo to be consistent with WorkspaceInfo/ProjectInfo.
public interface Participant {

  /**
   * Returns a unique ID for the user.
   */
  String getUserId();

  /**
   * @return the active client ID for this participant
   */
  String getId();
}
