/*******************************************************************************
 * Copyright (c) 2004 Actuate Corporation.
 * 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:
 *  Actuate Corporation  - initial API and implementation
 *******************************************************************************/

package org.eclipse.birt.report.engine.api;

import org.eclipse.birt.core.exception.BirtException;

public interface IReportDocumentLockManager
{

	/**
	 * try to lock a file, onece the user get the lock of the file, it should
	 * synchronize the locker to read/write the report document.
	 * 
	 * @param document
	 * @return the locker.
	 * @throws BirtException
	 */
	IReportDocumentLock lock( String document ) throws BirtException;
}
