com.viiyue.plugins.mybatis.mapper.special.ForUpdateMapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mybatis-mapper Show documentation
Mybatis generic mapper plugin for solving most basic operations, simplifying sql syntax and improving dynamic execution efficiency
There is a newer version: 1.3.7
Show newest version
/**
 * Copyright (C) 2017 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
 *
 *     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.viiyue.plugins.mybatis.mapper.special;

import java.io.Serializable;
import java.util.List;

import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.SelectProvider;

import com.viiyue.plugins.mybatis.annotation.mark.EnableResultMap;
import com.viiyue.plugins.mybatis.annotation.mark.Reference;
import com.viiyue.plugins.mybatis.mapper.Marker;
import com.viiyue.plugins.mybatis.provider.DynamicProvider;
import com.viiyue.plugins.mybatis.provider.base.BaseSelectProvider;

/**
 * Some pessimistic lock api method interface definition
 * 
 * @author tangxbai
 * @since 1.1.0
 * 
 * @param  database entity type
 * @param  query data return entity type
 * @param  primary key type, must be a {@link Serializable} implementation class.
 */
public interface ForUpdateMapper extends Marker {

	/**
	 * 
	 * Query the data list by non-null attributes in the object, and will lock
	 * the eligible data.
	 * 
	 * 
Node: 
	 * If you have used logically deletion, it will automatically
	 * exclude the logically deleted data.
	 * 

	 * 
	 * @param param database entity object
	 * @return the result list
	 */
	@EnableResultMap
	@Reference( method = "select", append = " [for update]" )
	@SelectProvider( type = BaseSelectProvider.class, method = DynamicProvider.dynamicSQL )
	List selectForUpdate( DO param );

	/**
	 * 

	 * Query the specified data by primary key, and will lock
	 * the eligible data.
	 * 
	 * 
Node: 
	 * If you have used logically deletion, it will automatically
	 * exclude the logically deleted data.
	 * 

	 * 
	 * @param parimaryKey primary key value
	 * @return specific primary key data
	 */
	@EnableResultMap
	@Reference( method = "selectByPrimaryKey", append = " [for update]" )
	@SelectProvider( type = BaseSelectProvider.class, method = DynamicProvider.dynamicSQL )
	DTO selectByPrimaryKeyForUpdate( PK parimaryKey );
	
	/**
	 * 

	 * In the case of multiple primary keys, query the specified data by
	 * specifying the primary key index and primary key value.
	 * And will lock the eligible data.
	 * 
	 * 
Node: 
	 * If you have used logically deletion, it will automatically
	 * exclude the logically deleted data.
	 * 

	 * 
	 * @param index the primary key index
	 * @param parimaryKey primary key value
	 * @return specific primary key data
	 */
	@EnableResultMap
	@Reference( method = "selectByPrimaryKeyIndex", append = " [for update]" )
	@SelectProvider( type = BaseSelectProvider.class, method = DynamicProvider.dynamicSQL )
	DTO selectByPrimaryKeyIndexForUpdate( @Param( "index" ) Integer index, @Param( "pk" ) PK parimaryKey );

	/**
	 * 

	 * Query data list by primary key array, and will lock
	 * the eligible data.
	 * 
	 * 
Node: 
	 * If you have used logically deletion, it will automatically
	 * exclude the logically deleted data.
	 * 

	 * 
	 * @param parimaryKeys primary key array
	 * @return the result list
	 */
	@EnableResultMap
	@Reference( method = "selectByPrimaryKeyGroup", append = " [for update]" )
	@SelectProvider( type = BaseSelectProvider.class, method = DynamicProvider.dynamicSQL )
	List selectByPrimaryKeyGroupForUpdate( @Param( "inArguments" ) PK ... parimaryKeys );

	/**
	 * 

	 * In the case of multiple primary keys, query the data list by specifying
	 * the primary key index and the primary key array.
	 * And will lock the eligible data.
	 * 
	 * 
Node: 
	 * If you have used logically deletion, it will automatically
	 * exclude the logically deleted data.
	 * 
	 * 
	 * @param index the primary key index
	 * @param parimaryKeys primary key array
	 * @return the result list
	 */
	@EnableResultMap
	@Reference( method = "selectByPrimaryKeyIndexGroup", append = " [for update]" )
	@SelectProvider( type = BaseSelectProvider.class, method = DynamicProvider.dynamicSQL )
	List selectByPrimaryKeyIndexGroupForUpdate( @Param( "index" ) Integer index, @Param( "inArguments" ) PK ... parimaryKeys );
	
}