com.github.jinahya.openfire.persistence.ibatis.mapper.OfPropMapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openfire-bind Show documentation

bindings for Openfire

There is a newer version: 0.1.9

/*
 * Copyright 2017 Jin Kwon <onacit at gmail.com>.
 *
 * 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.github.jinahya.openfire.persistence.ibatis.mapper;

import com.github.jinahya.openfire.persistence.OfProp;
import static com.github.jinahya.openfire.persistence.ibatis.mapper.OfMappedMapper.PARAM_CATALOG;
import static com.github.jinahya.openfire.persistence.ibatis.mapper.OfMappedMapper.PARAM_SCHEMA;
import java.util.List;
import javax.validation.constraints.NotNull;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.session.RowBounds;

/**
 * Interface for {@link OfProp}.
 *
 * @author Jin Kwon <onacit at gmail.com>
 * @param  ofProp type parameter
 */
public interface OfPropMapper> extends OfMappedMapper {

    String PARAM_NAME = "name";

    // -------------------------------------------------------------------------
    /**
     * Selects one whose {@value OfProp#COLUMN_NAME_NAME} column matches to
     * given.
     *
     * @param catalog an optional value for database catalog; may be
     * {@code null}.
     * @param schema an optional value for database schema; may be {@code null}.
     * @param name the value for {@value OfProp#COLUMN_NAME_NAME} column.
     * @return found entity or {@code null} if not found
     */
    T selectOne01(@Param(PARAM_CATALOG) String catalog,
                  @Param(PARAM_SCHEMA) String schema,
                  @NotNull @Param(PARAM_NAME) String name);

    List selectList01(@Param(PARAM_CATALOG) String catalog,
                         @Param(PARAM_SCHEMA) String schema,
                         @Param(PARAM_ASCENDING) boolean ascending,
                         RowBounds rowBounds);
}