1 /**
2 * Copyright 2004-2015 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.department;
17
18 import org.kuali.kpme.core.api.mo.KpmeEffectiveKeyedDataTransferObject;
19 import org.kuali.kpme.core.api.util.HrApiConstants;
20
21 /**
22 * <p>DepartmentContract interface.</p>
23 *
24 */
25 public interface DepartmentContract extends KpmeEffectiveKeyedDataTransferObject {
26
27 public static final String CACHE_NAME = HrApiConstants.CacheNamespace.NAMESPACE_PREFIX + "Department";
28
29 /**
30 * The Primary Key of a Department entry saved in a database
31 *
32 * <p>
33 * hrDeptId of Department
34 * <p>
35 *
36 * @return hrDeptId for Department
37 */
38 public String getHrDeptId();
39
40 /**
41 * Text field used to identify the Department
42 *
43 * <p>
44 * dept of Department
45 * <p>
46 *
47 * @return dept for Department
48 */
49 public String getDept();
50
51 /**
52 * Text which describes the department value
53 *
54 * <p>
55 * description of Department
56 * <p>
57 *
58 * @return description for Department
59 */
60 public String getDescription();
61
62 /**
63 * Chart value under which the Department is defined
64 *
65 * <p>
66 * chart of Department
67 * <p>
68 *
69 * @return chart for Department
70 */
71 public String getChart();
72
73 /**
74 * Organization value under which the Department is defined
75 *
76 * <p>
77 * org of Department
78 * <p>
79 *
80 * @return org for Department
81 */
82 public String getOrg();
83
84 /**
85 * Chart object under which the Department is defined
86 *
87 * <p>
88 * chartObj of Department
89 * <p>
90 *
91 * @return chartObj for Department
92 */
93 //public ChartContract getChartObj();
94
95 /**
96 * Organization under which the Department is defined
97 *
98 * <p>
99 * org of Department
100 * <p>
101 *
102 * @return org for Department
103 */
104 //public OrganizationContract getOrgObj();
105
106 /**
107 * List of Active principal role approvers for this Department
108 *
109 * <p>
110 * roleMembers of WorkArea
111 * </p>
112 *
113 * @return roleMembers for WorkArea
114 */
115 //public List<? extends DepartmentPrincipalRoleMemberBoContract> getRoleMembers();
116
117 /**
118 * List of Inactive principal role approvers for this Department
119 *
120 * <p>
121 * inactiveRoleMembers of WorkArea
122 * </p>
123 *
124 * @return inactiveRoleMembers for WorkArea
125 */
126 //public List<? extends DepartmentPrincipalRoleMemberBoContract> getInactiveRoleMembers();
127
128
129 /**
130 * Indicates if this Department needs payroll approval
131 *
132 * <p>
133 * payrollApproval of Department
134 * </p>
135 *
136 * @return true if needs payroll approval, false if not
137 */
138 public boolean isPayrollApproval();
139 }