001/**
002 * Copyright 2004-2015 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.time.service.mobile;
017
018import java.sql.Timestamp;
019import java.util.List;
020import java.util.Map;
021
022/**
023 * <p>ClockEntryInfoContract interface</p>
024 *
025 */
026public interface ClockEntryInfoContract {
027        
028        /**
029         * The map of assignment key to assignment description associated with the ClockEntryInfo
030         * 
031         * <p>
032         * assignKeyToAssignmentDescriptions of a ClockEntryInfo
033         * <p>
034         * 
035         * @return assignKeyToAssignmentDescriptions for ClockEntryInfo
036         */
037        public Map<String, String> getAssignKeyToAssignmentDescriptions();
038        
039        /**
040         * The lastClockLogDescription associated with the ClockEntryInfo
041         * 
042         * <p>
043         * lastClockLogDescription of a ClockEntryInfo
044         * <p>
045         * 
046         * @return lastClockLogDescription for ClockEntryInfo
047         */
048        public String getLastClockLogDescription();
049        
050        /**
051         * TODO: Make suret this comment is right
052         * The list of clock actions associated with the ClockEntryInfo
053         * 
054         * <p>
055         * clockActions of a ClockEntryInfo
056         * <p>
057         * 
058         * @return clockActions for ClockEntryInfo
059         */
060        public List<String> getClockActions();
061        
062        /**
063         * The current time associated with the ClockEntryInfo
064         * 
065         * <p>
066         * currentTime of a ClockEntryInfo
067         * <p>
068         * 
069         * @return currentTime for ClockEntryInfo
070         */
071        public Timestamp getCurrentTime();
072
073}