001/**
002 * Copyright 2004-2014 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.kpme.tklm.api.leave.block;
017
018import java.sql.Timestamp;
019
020
021/**
022 * <p>LeaveBlockHistoryContract interface</p>
023 *
024 */
025public interface LeaveBlockHistoryContract extends LeaveBlockContract {
026
027        /**
028         * The primary key of a LeaveBlockHistory entry saved in a database
029         * 
030         * <p>
031         * lmLeaveBlockHistoryId of a LeaveBlockHistory
032         * <p>
033         * 
034         * @return lmLeaveBlockHistoryId for LeaveBlockHistory
035         */
036        public String getLmLeaveBlockHistoryId(); 
037
038        /**
039         * The action associated with the LeaveBlockHistory
040         * 
041         * <p>
042         * action of a LeaveBlockHistory
043         * <p>
044         * 
045         * @return action for LeaveBlockHistory
046         */     
047        public String getAction();
048
049        /**
050         * TODO: Put a better comment
051         * The principalIdDeleted associated with the LeaveBlockHistory
052         * 
053         * <p>
054         * principalIdDeleted of a LeaveBlockHistory
055         * <p>
056         * 
057         * @return principalIdDeleted for LeaveBlockHistory
058         */
059        public String getPrincipalIdDeleted();
060
061        /**
062         * TODO: Put a better comment
063         * The timestampDeleted associated with the LeaveBlockHistory
064         * 
065         * <p>
066         * timestampDeleted of a LeaveBlockHistory
067         * <p>
068         * 
069         * @return timestampDeleted for LeaveBlockHistory
070         */
071        public Timestamp getTimestampDeleted();
072        
073        /**
074         * The assignment title associated with the LeaveBlockHistory
075         * 
076         * <p>
077         * If the leave block associated with the LeaveBlockHistory is not null, it checks its work area.  If the work area is not null,
078         * it gets its description and its task.  If the task is not null and not the default task, it gets the task description.
079         * <p>
080         * 
081         * @return "work area description - task description" for LeaveBlockHistory
082         */
083        public String getAssignmentTitle();
084}