001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (https://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.lock;
029
030/**
031 * Bean class which keeps track of a locking action performed on a resource.<p>
032 */
033public class CmsLockActionRecord {
034
035    /** A type for the different locking actions. */
036    public enum LockChange {
037        /** The lock was changed. */
038        changed,
039        /** The resource was locked. */
040        locked,
041        /** The lock state was not modified. */
042        unchanged;
043    }
044
045    /** The lock state after the action. */
046    private CmsLock m_lock;
047
048    /** The action type. */
049    private LockChange m_change;
050
051    /**
052     * Creates a new instance.<p>
053     *
054     * @param lock the lock state after the action
055     * @param change the action type
056     */
057    public CmsLockActionRecord(CmsLock lock, LockChange change) {
058
059        m_lock = lock;
060        m_change = change;
061    }
062
063    /**
064     * Gets the change type.<p>
065     *
066     * @return the change type
067     */
068    public LockChange getChange() {
069
070        return m_change;
071    }
072
073    /**
074     * Gets the lock state after the action.<p>
075     *
076     * @return the lock state after the action
077     */
078    public CmsLock getLock() {
079
080        return m_lock;
081    }
082
083}