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.time.rules.clocklocation;
017
018import java.util.List;
019
020import org.kuali.kpme.core.api.department.DepartmentContract;
021import org.kuali.kpme.core.api.job.JobContract;
022import org.kuali.kpme.core.api.workarea.WorkAreaContract;
023import org.kuali.kpme.tklm.api.time.rules.TkRuleKeyedContract;
024import org.kuali.rice.kim.api.identity.Person;
025
026/**
027 * <p>ClockLocationRuleContract interface</p>
028 *
029 */
030public interface ClockLocationRuleContract extends TkRuleKeyedContract{ //TkRuleContract 
031        
032        /**
033         * The work area associated with the ClockLocationRule
034         * 
035         * <p>
036         * If a work area is defined, only entries associated with a job in this work area will be subject to IP address validation.
037         * <p>
038         * 
039         * @return workArea for ClockLocationRule
040         */
041        public Long getWorkArea();
042        
043        /**
044         * The principalId associated with the ClockLocationRule
045         * 
046         * <p>
047         * If a principal id is defined, only this specific employee will be subject to IP address validation.
048         * <p>
049         * 
050         * @return principalId for ClockLocationRule
051         */
052        public String getPrincipalId();
053        
054        /**
055         * TODO: Is this field needed??
056         * The user principal id associated with the ClockLocationRule
057         * 
058         * <p>
059         * userPrincipalId of a ClockLocationRule
060         * <p>
061         * 
062         * @return userPrincipalId for ClockLocationRule
063         */
064        public String getUserPrincipalId();
065
066        /**
067         * The jobNumber associated with the ClockLocationRule
068         * 
069         * <p>
070         * If job # is defined, only this specific employees job will be subject to IP address validation.
071         * <p>
072         * 
073         * @return jobNumber for ClockLocationRule
074         */
075        public Long getJobNumber();
076        
077        /**
078         * The Department object associated with the ClockLocationRule
079         * 
080         * <p>
081         * If a department is defined, only entries associated with a job in this department will be subject to IP address validation.
082         * <p>
083         * 
084         * @return department for ClockLocationRule
085         */
086        public DepartmentContract getDepartment();
087        
088        /**
089         * The WorkArea object associated with the ClockLocationRule
090         * 
091         * <p>
092         * If a work area is defined, only entries associated with a job in this work area will be subject to IP address validation.
093         * <p>
094         * 
095         * @return workAreaObj for ClockLocationRule
096         */
097        public WorkAreaContract getWorkAreaObj();
098
099        /**
100         * The Job object associated with the ClockLocationRule
101         * 
102         * <p>
103         * If job # is defined, only this specific employees job will be subject to IP address validation.
104         * <p>
105         * 
106         * @return job for ClockLocationRule
107         */
108        public JobContract getJob();
109
110        /**
111         * The primary key of a ClockLocationRule entry saved in a database
112         * 
113         * <p>
114         * tkClockLocationRuleId of a ClockLocationRule
115         * <p>
116         * 
117         * @return tkClockLocationRuleId for ClockLocationRule
118         */
119        public String getTkClockLocationRuleId();
120
121        /**
122         * The department associated with the ClockLocationRule
123         * 
124         * <p>
125         * If a department is defined, only entries associated with a job in this department will be subject to IP address validation.
126         * <p>
127         * 
128         * @return dept for ClockLocationRule
129         */
130        public String getDept();
131        
132        /**
133         * The history flag of the ClockLocationRule
134         * 
135         * <p>
136         * history flag of a ClockLocationRule
137         * <p>
138         * 
139         * @return Y if on, N if not
140         */
141        public Boolean getHistory();
142
143        /**
144         * The Person object associated with the ClockLocationRule
145         * 
146         * <p>
147         * If a principal id is defined, only this specific employee will be subject to IP address validation.
148         * <p>
149         * 
150         * @return principal for ClockLocationRule
151         */
152        public Person getPrincipal();
153
154        /**
155         * The hrDeptId associated with the ClockLocationRule
156         * 
157         * <p>
158         * hrDeptId of a ClockLocationRule
159         * <p>
160         * 
161         * @return hrDeptId for ClockLocationRule
162         */
163        public String getHrDeptId();
164        
165        /**
166         * The tkWorkAreaId associated with the ClockLocationRule
167         * 
168         * <p>
169         * tkWorkAreaId of a ClockLocationRule
170         * <p>
171         * 
172         * @return tkWorkAreaId for ClockLocationRule
173         */
174        public String getTkWorkAreaId();
175
176        /**
177         * The hrJobId associated with the ClockLocationRule
178         * 
179         * <p>
180         * hrJobId of a ClockLocationRule
181         * <p>
182         * 
183         * @return hrJobId for ClockLocationRule
184         */
185        public String getHrJobId();
186        
187        /**
188         * The list of ClockLocationRuleIpAddress objects associated with the ClockLocationRule
189         * 
190         * <p>
191         * ipAddresses of a ClockLocationRule
192         * <p>
193         * 
194         * @return ipAddresses for ClockLocationRule
195         */
196        public List<? extends ClockLocationRuleIpAddressContract> getIpAddresses();
197
198        /**
199         * The IP Address to be used for validation
200         * 
201         * <p>
202         * for lookup and inquiry display only
203         * <p>
204         * 
205         * @return ip addresses string for ClockLocationRule
206         */
207        public String getIpAddressesString();
208        
209
210}