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