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.core.user.UserIdentity;
019import org.ametys.plugins.repository.AmetysObject;
020import org.ametys.plugins.repository.AmetysRepositoryException;
021
022/**
023 * {@link AmetysObject} that knows about its lock status.
024 */
025public interface LockAwareAmetysObject extends AmetysObject
026{
027    /**
028     * Returns true if this {@link AmetysObject} is locked
029     * @return true if this {@link AmetysObject} is locked
030     * @throws AmetysRepositoryException if a problem occurs
031     */
032    public boolean isLocked() throws AmetysRepositoryException;
033
034    /**
035     * Returns the owner of the lock, or null if none
036     * @return the owner of the lock, or null if none
037     * @throws AmetysRepositoryException if a problem occurs
038     */
039    public UserIdentity getLockOwner() throws AmetysRepositoryException;
040}