/*
 * MosP - Mind Open Source Project    http://www.mosp.jp/
 * Copyright (C) MIND Co., Ltd.       http://www.e-mind.co.jp/
 * 
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
/**
 * 
 */
package jp.mosp.time.bean;

import java.util.Date;
import java.util.List;

import jp.mosp.framework.base.MospException;
import jp.mosp.time.dto.settings.OvertimeRequestDtoInterface;

/**
 * 残業申請参照インターフェース。
 */
public interface OvertimeRequestReferenceBeanInterface {
	
	/**
	 * 残業申請情報リストを取得する。<br>
	 * 対象個人IDの対象期間における申請を取得する。<br>
	 * @param personalId 対象個人ID
	 * @param firstDate  対象期間初日
	 * @param lastDate   対象期間最終日
	 * @return 残業申請情報リスト
	 * @throws MospException インスタンスの取得或いはSQL実行に失敗した場合
	 */
	List<OvertimeRequestDtoInterface> getOvertimeRequestList(String personalId, Date firstDate, Date lastDate)
			throws MospException;
	
	/**
	 * 残業申請データからレコードを取得する。<br>
	 * 個人ID、申請日、残業区分で合致するレコードが無い場合、nullを返す。<br>
	 * @param personalId 個人ID
	 * @param requestDate 申請日
	 * @param overtimeType 残業区分
	 * @return 残業申請データDTO
	 * @throws MospException インスタンスの取得或いはSQL実行に失敗した場合
	 */
	OvertimeRequestDtoInterface findForKeyOnWorkflow(String personalId, Date requestDate, int overtimeType)
			throws MospException;
	
	/**
	 * 残業申請データからレコードを取得する。<br>
	 * 個人ID、申請日、残業区分で合致するレコードが無い場合、nullを返す。<br>
	 * @param personalId 個人ID
	 * @param requestDate 申請日
	 * @param overtimeType 残業区分
	 * @return 残業申請データDTO
	 * @throws MospException インスタンスの取得或いはSQL実行に失敗した場合
	 */
	OvertimeRequestDtoInterface findForKey(String personalId, Date requestDate, int overtimeType) throws MospException;
	
	/**
	 * 申請日の承認状態を取得する。<br>
	 * 申請日の残業申請が全て承認完了である場合は「残済 」、
	 * 1件でも承認完了でない場合は「残申 」、
	 * 申請していない場合は「""」を返す。
	 * @param personalId 個人ID
	 * @param requestDate 申請日
	 * @return 承認状態
	 * @throws MospException インスタンスの取得或いはSQL実行に失敗した場合
	 */
	String getStatusForRequestDate(String personalId, Date requestDate) throws MospException;
	
	/**
	 * @param id レコード識別ID
	 * @return 残業申請データDTO
	 * @throws MospException インスタンスの取得或いはSQL実行に失敗した場合
	 */
	OvertimeRequestDtoInterface findForId(long id) throws MospException;
	
	/**
	 * ワークフロー番号からレコードを取得する。<br>
	 * ワークフロー番号で合致するレコードが無い場合、nullを返す。<br>
	 * @param workflow ワークフロー番号
	 * @return 残業申請データDTO
	 * @throws MospException インスタンスの取得或いはSQL実行に失敗した場合
	 */
	OvertimeRequestDtoInterface findForWorkflow(long workflow) throws MospException;
	
	/**
	 * 承認段階、承認状況から残業申請一覧を取得する。<br>
	 * @param personalId 個人ID
	 * @param workflowStage 承認段階
	 * @param workflowStatus 承認状況
	 * @param routeCode ルートコード
	 * @return 残業申請データリスト
	 * @throws MospException インスタンスの取得或いはSQL実行に失敗した場合
	 */
	List<OvertimeRequestDtoInterface> getListForWorkflowStatus(String personalId, int workflowStage,
			String workflowStatus, String routeCode) throws MospException;
	
	/**
	 * 未承認残業申請データリストを取得する。<br>
	 * @param personalId 個人ID
	 * @param approvalStage 承認段階
	 * @return 未承認残業申請データリスト
	 * @throws MospException インスタンスの取得或いはSQL実行に失敗した場合
	 */
	List<OvertimeRequestDtoInterface> getListForNotApproved(String personalId, int approvalStage) throws MospException;
	
	/**
	 * 残業申請データ取得。
	 * <p>
	 * レコード識別IDから残業申請データを取得。
	 * </p>
	 * @param id レコード識別ID
	 * @return 残業申請データ
	 * @throws MospException インスタンスの取得或いはSQL実行に失敗した場合
	 */
	OvertimeRequestDtoInterface findForKey(long id) throws MospException;
	
	/**
	 * 基本情報チェック
	 * @param personalId 個人ID
	 * @param targetDate 対象日
	 * @throws MospException インスタンスの取得或いはSQL実行に失敗した場合
	 */
	void chkBasicInfo(String personalId, Date targetDate) throws MospException;
	
}
