org.jboss.dna.graph.commands
Interface GetChildrenCommand

All Superinterfaces:

ActsOnPath, Cacheable, GraphCommand, Serializable

All Known Subinterfaces:

GetNodeCommand

All Known Implementing Classes:

BasicGetChildrenCommand, BasicGetNodeCommand, FederatedNode, ProjectedGetChildrenCommand, ProjectedGetNodeCommand

public interface GetChildrenCommand
extends GraphCommand, ActsOnPath, Cacheable

A command to get the children of a single node given its path.

Author:

Randall Hauch

Method Summary

void	addChild(Path.Segment nameOfChild, Property... identityProperties) Add the child to this node.
void	setNoChildren() Set that this node has no children.

Methods inherited from interface org.jboss.dna.graph.commands.GraphCommand

getError, hasError, hasNoError, isCancelled, setError

Methods inherited from interface org.jboss.dna.graph.commands.ActsOnPath

getPath

Methods inherited from interface org.jboss.dna.graph.cache.Cacheable

getCachePolicy, getTimeLoaded, setCachePolicy

Method Detail

addChild

void addChild(Path.Segment nameOfChild,
              Property... identityProperties)

Add the child to this node. This method does not affect existing children, so callers of this method should not add a child with the same segment as an existing child (this is not checked by this method).

Parameters:

nameOfChild - the name of the child; should not be the same as an existing child (not checked)

identityProperties - the property/properties that are considered identity properties (other than the name) for the child

setNoChildren

void setNoChildren()

Set that this node has no children. Any existing child references already set on this command will be removed.