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 */
016
017package org.ametys.plugins.repository;
018
019/**
020 * Modifiable {@link AmetysObject}.
021 */
022public interface ModifiableAmetysObject extends AmetysObject
023{
024    /**
025     * Rename the {@link AmetysObject}
026     * @param newName the new name of the ametys object
027     * @throws AmetysRepositoryException if an error occurs.
028     */
029    void rename(String newName) throws AmetysRepositoryException;
030    
031    /**
032     * Returns true if there is pending changes.
033     * @return true if there is pending changes.
034     * @throws AmetysRepositoryException if an error occurs.
035     */
036    public boolean needsSave() throws AmetysRepositoryException;
037    
038    /**
039     * Persists pending changes.<br>
040     * If the underlying Node is new, the Session is globally saved.
041     * @throws AmetysRepositoryException if an error occurs.
042     */
043    public void saveChanges() throws AmetysRepositoryException;
044    
045    /**
046     * Discard pending changes and revert to the currently persisted version.<br>
047     * @throws AmetysRepositoryException if an error occurs.
048     */
049    public void revertChanges() throws AmetysRepositoryException;
050}