001    /*
002     * JBoss, Home of Professional Open Source.
003     * Copyright 2008, Red Hat Middleware LLC, and individual contributors
004     * as indicated by the @author tags. See the copyright.txt file in the
005     * distribution for a full listing of individual contributors. 
006     *
007     * This is free software; you can redistribute it and/or modify it
008     * under the terms of the GNU Lesser General Public License as
009     * published by the Free Software Foundation; either version 2.1 of
010     * the License, or (at your option) any later version.
011     *
012     * This software 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     * You should have received a copy of the GNU Lesser General Public
018     * License along with this software; if not, write to the Free
019     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021     */
022    package org.jboss.dna.graph.commands;
023    
024    import org.jboss.dna.graph.cache.Cacheable;
025    import org.jboss.dna.graph.properties.Path;
026    import org.jboss.dna.graph.properties.Property;
027    
028    /**
029     * A command to get the children of a single node given its path.
030     * 
031     * @author Randall Hauch
032     */
033    public interface GetChildrenCommand extends GraphCommand, ActsOnPath, Cacheable {
034    
035        /**
036         * Add the child to this node. This method does not affect existing children, so callers of this method should not add a child
037         * with the same segment as an existing child (this is not checked by this method).
038         * 
039         * @param nameOfChild the name of the child; should not be the same as an existing child (not checked)
040         * @param identityProperties the property/properties that are considered identity properties (other than the name) for the
041         *        child
042         */
043        void addChild( Path.Segment nameOfChild,
044                       Property... identityProperties );
045    
046        /**
047         * Set that this node has no children. Any existing child references already set on this command will be removed.
048         */
049        void setNoChildren();
050    }