/**
 *
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package com.agfa.hap.sdo;


/**
 * Visitor interface for visiting all properties belong to a snapshot.
 * @author AMOCZ
 * @see SnapshotDefinition
 */
public interface ObjectPropertyVisitor {
	void startDataObject(Object instance, Type type) throws Exception;
	boolean visitProperty(Object instance, Property property, Object value) throws Exception;
	void visitProxyProperty(Object instance, Property property, Object identity) throws Exception;
	void endDataObject(Object instance, Type type) throws Exception;

	/**
	 * Bulk properties are properties that are heavy to retrieve and as such should
	 * be visited in bulk. A typical example is a property that can only be filled in
	 * by doing a query.
	 * Bulk properties are visited after all other objects have been visited.
	 */
	void visitBulkProperty(Object instance, Property property, SnapshotDefinition subselect);
}