/*
 * Copyright (c) 2010-2013 Evolveum
 *
 * Licensed 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.evolveum.midpoint.common.validator;

import com.evolveum.midpoint.prism.Objectable;
import com.evolveum.midpoint.prism.PrismObject;
import com.evolveum.midpoint.schema.result.OperationResult;

import org.w3c.dom.Element;
import org.w3c.dom.Node;

/**
 * Set of callback methods used to convey information from the validator to the "working" code.
 * 
 * It is used e.g. to connect validator to the code that executes import. It makes validator quite a generic tool.
 * E.g. it can be used as the base of the import in the system and the same validator can be used in tests to
 * check the validity of samples.
 *
 * @author Radovan Semancik
 */
public interface EventHandler {

	/**
	 * Call-back called after deserializing to DOM and static schema validation but before unmarshall to JAXB.
	 * It can be used for extra DOM-based checks or transformations of the object.
	 *  
	 * @param objectElement DOM tree parsed from file
	 * @param postValidationTree post-validation DOM tree
	 * @param objectResult Operation result for this object
	 * @return true if the process should continue, false if it should stop
	 */
	public EventResult preMarshall(Element objectElement, Node postValidationTree, OperationResult objectResult);
	
	/**
	 * Call-back called after the object is unmarshalled.
	 * 
	 * The compliance with static schemas should already be checked. This is the "main" call-back as it is expected that
	 * this call-back will do the primary part of work such storing the object to repository during import.
	 *  
	 * @param object unmarshalled JAXB object
	 * @param objectElement DOM tree parsed from the fil
	 * @param objectResult Operation result for this object
	 * @return true if the process should continue, false if it should stop
	 */
    public <T extends Objectable> EventResult postMarshall(PrismObject<T> object, Element objectElement, OperationResult objectResult);
    
    /**
     * Call-back to handle global errors.
     * 
     * This callback will be called with any error that cannot be attributed to any particular object.
     * 
     * @param currentResult Operation result pointing to the particular error.
     * @return true if the process should continue, false if it should stop
     */
    public void handleGlobalError(OperationResult currentResult);

}