/*
 * Copyright 2011-2020 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.data.jpa.repository.support;

import java.lang.reflect.Method;
import java.util.Map;
import java.util.Optional;

import javax.persistence.LockModeType;

import org.springframework.data.jpa.repository.EntityGraph;
import org.springframework.lang.Nullable;

Interface to abstract CrudMethodMetadata that provide the LockModeType to be used for query execution. 
Author:
Oliver Gierke, Thomas Darimont, Christoph Strobl, Mark Paluch, Jens Schauder/**
 * Interface to abstract {@link CrudMethodMetadata} that provide the {@link LockModeType} to be used for query
 * execution.
 *
 * @author Oliver Gierke
 * @author Thomas Darimont
 * @author Christoph Strobl
 * @author Mark Paluch
 * @author Jens Schauder
 */
public interface CrudMethodMetadata {

	
Returns the LockModeType to be used. 
Returns:
/**
	 * Returns the {@link LockModeType} to be used.
	 *
	 * @return
	 */
	@Nullable
	LockModeType getLockModeType();

	
Returns all query hints to be applied to queries executed for the CRUD method.
Returns:
/**
	 * Returns all query hints to be applied to queries executed for the CRUD method.
	 *
	 * @return
	 */
	Map<String, Object> getQueryHints();

	
Returns all query hints to be applied to count queries executed for the CRUD method. The default implementation just delegates to getQueryHints(). 
Returns:
Since:
2.2/**
	 * Returns all query hints to be applied to count queries executed for the CRUD method. The default implementation
	 * just delegates to {@link #getQueryHints()}.
	 *
	 * @return
	 * @since 2.2
	 */
	default Map<String, Object> getQueryHintsForCount() {
		return getQueryHints();
	}

	
Returns the EntityGraph to be used. 
Returns:
Since:
1.9/**
	 * Returns the {@link EntityGraph} to be used.
	 *
	 * @return
	 * @since 1.9
	 */
	Optional<EntityGraph> getEntityGraph();

	
Returns the Method to be used. 
Returns:
Since:
1.9/**
	 * Returns the {@link Method} to be used.
	 *
	 * @return
	 * @since 1.9
	 */
	Method getMethod();
}