/*
 * Copyright 2021 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 * 
 * 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 org.keycloak.models.map.common.delegate;

import org.keycloak.models.map.common.EntityField;

/**
 * Interface for a provider of a delegate of type {@code T}, optionally
 * providing the flag on the object been updated.
 * @author hmlnarik
 */
public interface DelegateProvider<T> {
    /**
     * Returns a delegate for and entity for an operation on a field.
     * @param isRead {@code true} when the delegate requested for a read operation, false otherwise
     * @param field Identification of the field this delegates operates on. While this parameter
     *              can be any object including {@code null}, if it is a known field, then it is guaranteed to be
     *              one of the {@code EntityField}s enumerated in one of the {@code Map*EntityFields} enum.
     * @return
     */
    T getDelegate(boolean isRead, Enum<? extends EntityField<T>> field, Object... parameters);

    default boolean isUpdated() { return false; }
}
