/**
 * Copyright (c) 2010-2016 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.model.api.context;

import java.util.Collection;
import java.util.Set;

import javax.xml.namespace.QName;

import com.evolveum.midpoint.prism.PrismObject;
import com.evolveum.midpoint.prism.delta.DeltaSetTriple;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.security.api.Authorization;
import com.evolveum.midpoint.task.api.Task;
import com.evolveum.midpoint.util.DebugDumpable;
import com.evolveum.midpoint.util.exception.ObjectNotFoundException;
import com.evolveum.midpoint.util.exception.PolicyViolationException;
import com.evolveum.midpoint.util.exception.SchemaException;
import com.evolveum.midpoint.xml.ns._public.common.common_3.AdminGuiConfigurationType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.AssignmentType;
import com.evolveum.midpoint.xml.ns._public.common.common_3.FocusType;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public interface EvaluatedAssignment<F extends FocusType> extends DebugDumpable {

	AssignmentType getAssignmentType();

	Collection<Authorization> getAuthorizations();
	
	Collection<AdminGuiConfigurationType> getAdminGuiConfigurations();
	
	DeltaSetTriple<? extends EvaluatedAssignmentTarget> getRoles();

	DeltaSetTriple<EvaluatedConstruction> getEvaluatedConstructions(Task task, OperationResult result) throws SchemaException, ObjectNotFoundException;

	PrismObject<?> getTarget();
	
	QName getRelation();

	boolean isValid();

	boolean isPresentInCurrentObject();

	boolean isPresentInOldObject();
	
	/**
	 * Returns all policy rules that apply to the focal object and are derived from this assignment
	 * - even those that were not triggered. The policy rules are compiled from all the applicable
	 * sources (target, meta-roles, etc.)
	 */
	@NotNull
	Collection<EvaluatedPolicyRule> getFocusPolicyRules();
	
	/**
	 * Returns all policy rules that directly apply to the target object of this assignment
	 * (and are derived from this assignment) - even those that were not triggered. The policy rules
	 * are compiled from all the applicable sources (target, meta-roles, etc.)
	 */
	@NotNull
	Collection<EvaluatedPolicyRule> getThisTargetPolicyRules();

	/**
	 * Returns all policy rules that apply to some other target object of this assignment
	 * (and are derived from this assignment) - even those that were not triggered. The policy rules
	 * are compiled from all the applicable sources (target, meta-roles, etc.)
	 */
	@NotNull
	Collection<EvaluatedPolicyRule> getOtherTargetsPolicyRules();

	/**
	 * Returns all policy rules that apply to any of the target objects provided by this assignment
	 * (and are derived from this assignment) - even those that were not triggered. The policy rules
	 * are compiled from all the applicable sources (target, meta-roles, etc.)
	 *
	 * The difference to getThisTargetPolicyRules is that if e.g.
	 * jack is a Pirate, and Pirate induces Sailor, then
	 *  - getThisTargetPolicyRules will show rules that are attached to Pirate
	 *  - getAllTargetsPolicyRules will show rules that are attached to Pirate and Sailor
	 *  - getOtherTargetsPolicyRules will show rules that are attached to Sailor
	 */
	@NotNull
	Collection<EvaluatedPolicyRule> getAllTargetsPolicyRules();


	Collection<String> getPolicySituations();
	
	void triggerConstraint(@Nullable EvaluatedPolicyRule rule, EvaluatedPolicyRuleTrigger trigger) throws PolicyViolationException;
}