/**
 * This file Copyright (c) 2011-2012 Magnolia International
 * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
 *
 *
 * This file is dual-licensed under both the Magnolia
 * Network Agreement and the GNU General Public License.
 * You may elect to use one or the other of these licenses.
 *
 * This file is distributed in the hope that it will be
 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
 * Redistribution, except as permitted by whichever of the GPL
 * or MNA you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or
 * modify this file under the terms of the GNU General
 * Public License, Version 3, as published by the Free Software
 * Foundation.  You should have received a copy of the GNU
 * General Public License, Version 3 along with this program;
 * if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * 2. For the Magnolia Network Agreement (MNA), this file
 * and the accompanying materials are made available under the
 * terms of the MNA which accompanies this distribution, and
 * is available at http://www.magnolia-cms.com/mna.html
 *
 * Any modifications to this file must keep this entire header
 * intact.
 *
 */
package info.magnolia.jcr.decoration;

import javax.jcr.Node;
import javax.jcr.NodeIterator;
import javax.jcr.Property;
import javax.jcr.PropertyIterator;
import javax.jcr.Session;

/**
 * Applies custom behavior in a graph of JCR objects by wrapping objects. Allows for expressing the logic in a single
 * place.
 *
 * @version $Id$
 * @see AbstractContentDecorator
 */
public interface ContentDecorator {

    Session wrapSession(Session session);

    Node wrapNode(Node node);

    NodeIterator wrapNodeIterator(NodeIterator nodeIterator);

    /**
     * Evaluates if a node should be hidden by wrappers.
     *
     * @param node the node to evaluate
     * @return true if the node should be visible or false to hide it
     */
    boolean evaluateNode(Node node);

    Property wrapProperty(Property property);

    PropertyIterator wrapPropertyIterator(PropertyIterator propertyIterator);

    /**
     * Evaluates if a property should be hidden by wrappers.
     *
     * @param property the property to evaluate.
     * @return true if the property should be visible or false to hide it
     */
    boolean evaluateProperty(Property property);
}