1 /**
2 * Copyright 2004-2014 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.kpme.core.api.location;
17
18 import org.kuali.kpme.core.api.mo.KpmeEffectiveDataTransferObject;
19 import org.kuali.kpme.core.api.util.HrApiConstants;
20
21 /**
22 * <p>LocationContract interface.</p>
23 *
24 */
25 public interface LocationContract extends KpmeEffectiveDataTransferObject {
26
27 public static final String CACHE_NAME = HrApiConstants.CacheNamespace.NAMESPACE_PREFIX + "Location";
28
29 /**
30 * The Primary Key of a Location entry saved in a database
31 *
32 * <p>
33 * hrLocationId of Location
34 * <p>
35 *
36 * @return hrLocationId for Location
37 */
38 public String getHrLocationId();
39
40 /**
41 * Text field used to identify the location
42 *
43 * <p>
44 * location of Location
45 * <p>
46 *
47 * @return location for Location
48 */
49 public String getLocation();
50
51 /**
52 * Indicates the timezone for this location
53 *
54 * <p>
55 * timezone of Location
56 * <p>
57 *
58 * @return timezone for Location
59 */
60 public String getTimezone();
61
62 /**
63 * Text which describes the location code
64 *
65 * <p>
66 * description of Location
67 * <p>
68 *
69 * @return description for Location
70 */
71 public String getDescription();
72
73 public String getUserPrincipalId();
74
75
76 /**
77 * Active Role member list for the Location
78 *
79 * <p>
80 * roleMembers of Location
81 * </p>
82 *
83 * @return roleMembers for Location
84 */
85 //public List<? extends LocationPrincipalRoleMemberBoContract> getRoleMembers();
86
87 /**
88 * Inactive Role member list for the Location
89 *
90 * <p>
91 * roleMembers of Location
92 * </p>
93 *
94 * @return roleMembers for Location
95 */
96 //public List<? extends LocationPrincipalRoleMemberBoContract> getInactiveRoleMembers();
97
98 }