/**
 * Copyright (c) 2004 - 2009 Eike Stepper (Berlin, Germany) and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *    Simon McDuff - initial API and implementation
 *    Eike Stepper - maintenance
 */
package org.eclipse.emf.cdo;

import org.eclipse.emf.cdo.view.CDOView;

import org.eclipse.net4j.util.concurrent.RWLockManager;

import java.util.concurrent.locks.Lock;

/**
 * Once object got lock, it will not go in conflict mode or cannot be changed.
 * 
 * @author Simon McDuff
 * @since 2.0
 */
public interface CDOLock extends Lock
{
  /**
   * TODO Simon: JavaDoc
   */
  public static final int WAIT = RWLockManager.WAIT;

  /**
   * TODO Simon: JavaDoc
   */
  public static final int NO_WAIT = RWLockManager.NO_WAIT;

  /**
   * TODO Simon: JavaDoc
   */
  public RWLockManager.LockType getType();

  /**
   * Returns <code>true</code> if this lock is currently held by the requesting {@link CDOView view}, <code>false</code>
   * otherwise.
   */
  public boolean isLocked();

  /**
   * Returns <code>true</code> if this lock is currently held by another {@link CDOView view} (i.e. any view different
   * from the requesting one), <code>false</code> otherwise.
   */
  public boolean isLockedByOthers();
}