001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors.
008     *
009     * Unless otherwise indicated, all code in JBoss DNA is licensed
010     * to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     * 
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.graph.request;
025    
026    import org.jboss.dna.graph.Location;
027    import org.jboss.dna.graph.property.Path;
028    
029    /**
030     * A Request to make changes in a graph.
031     */
032    public abstract class ChangeRequest extends Request {
033    
034        private static final long serialVersionUID = 1L;
035    
036        protected ChangeRequest() {
037        }
038    
039        /**
040         * Determine if this request changes the branch at the given path.
041         * 
042         * @param workspace the name of the workspace; may not be null
043         * @param path the path; may not be null
044         * @return true if this request changes a node under the given path
045         */
046        public abstract boolean changes( String workspace,
047                                         Path path );
048    
049        /**
050         * Get the location of the top-most node that is to be changed by this request.
051         * 
052         * @return the location changed by this request
053         */
054        public abstract Location changedLocation();
055    
056        /**
057         * Get the name of the workspace that was changed by this request.
058         * 
059         * @return the name of the workspace changed by this request
060         */
061        public abstract String changedWorkspace();
062    }