001/*
002 *  Copyright 2010 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.repository.lock;
017
018import org.ametys.plugins.repository.AmetysObject;
019import org.ametys.plugins.repository.AmetysRepositoryException;
020
021/**
022 * {@link AmetysObject} that can be locked.
023 */
024public interface LockableAmetysObject extends LockAwareAmetysObject
025{
026    /**
027     * Locks this {@link AmetysObject}
028     * @throws AmetysRepositoryException if a problem occurs
029     */
030    public void lock() throws AmetysRepositoryException;
031
032    /**
033     * Unlocks this {@link AmetysObject}
034     * @throws AmetysRepositoryException if a problem occurs
035     */
036    public void unlock() throws AmetysRepositoryException;
037    
038    /**
039     * Sets a lock info on the current context for this object
040     * @throws AmetysRepositoryException if an error occurs
041     */
042    public void setLockInfoOnCurrentContext() throws AmetysRepositoryException;
043}