ExpectedPartitionValueDao.java

/*
* Copyright 2015 herd contributors
*
* 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.finra.herd.dao;

import java.util.List;

import org.finra.herd.model.api.xml.ExpectedPartitionValueKey;
import org.finra.herd.model.api.xml.PartitionValueRange;
import org.finra.herd.model.jpa.ExpectedPartitionValueEntity;

public interface ExpectedPartitionValueDao extends BaseJpaDao
{
    /**
     * Gets an expected partition value entity by partition key group name, expected partition value, and an optional offset.
     *
     * @param expectedPartitionValueKey the expected partition value key (case-insensitive)
     * @param offset the optional offset
     *
     * @return the expected partition value
     */
    public ExpectedPartitionValueEntity getExpectedPartitionValue(ExpectedPartitionValueKey expectedPartitionValueKey, int offset);

    /**
     * Gets a list of expected partition values by group.
     *
     * @param partitionKeyGroupName the partition key group name (case-insensitive)
     * @param partitionValueRange the optional partition value range
     *
     * @return the list of expected partition values
     */
    public List<ExpectedPartitionValueEntity> getExpectedPartitionValuesByGroupAndRange(String partitionKeyGroupName, PartitionValueRange partitionValueRange);

}