ChildrenRetrievalPolicy.cs

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// <copyright>Copyright 2012-2016 Lawo AG (http://www.lawo.com).</copyright>
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

namespace Lawo.EmberPlusSharp.Model
{
    /// <summary>Represents the policy how children for a given node should be retrieved from the provider.</summary>
    public enum ChildrenRetrievalPolicy
    {
        /// <summary>Do not retrieve any children.</summary>
        /// <remarks>No children will be retrieved as long as the <see cref="INode.ChildrenRetrievalPolicy"/>
        /// property of an <see cref="INode"/> implementation has this value.</remarks>
        None,

        /// <summary>Retrieve only direct children.</summary>
        /// <remarks>If the <see cref="INode.ChildrenRetrievalPolicy"/> property of an <see cref="INode"/> implementation
        /// has this value then only direct children were or will be retrieved for the node. The
        /// <see cref="INode.ChildrenRetrievalPolicy"/> property of the direct children implementing <see cref="INode"/>
        /// will have the initial value <see cref="None"/>.</remarks>
        DirectOnly,

        /// <summary>Retrieve direct and indirect children.</summary>
        /// <remarks>If the <see cref="INode.ChildrenRetrievalPolicy"/> property of an <see cref="INode"/> implementation
        /// has this value, then all direct and indirect children were or will be retrieved for the node. The
        /// <see cref="INode.ChildrenRetrievalPolicy"/> property of the direct and indirect children implementing
        /// <see cref="INode"/> will have the value <see cref="All"/>.</remarks>
        All
    }
}