001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 Echo Three, LLC
003//
004// Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
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// --------------------------------------------------------------------------------
016
017package com.echothree.control.user.employee.common;
018
019import com.echothree.control.user.employee.common.form.*;
020import com.echothree.model.data.user.common.pk.UserVisitPK;
021import com.echothree.util.common.command.CommandResult;
022
023public interface EmployeeService
024        extends EmployeeForms {
025    
026    // -------------------------------------------------------------------------
027    //   Responsibility Types
028    // -------------------------------------------------------------------------
029    
030    CommandResult createResponsibilityType(UserVisitPK userVisitPK, CreateResponsibilityTypeForm form);
031    
032    CommandResult getResponsibilityTypes(UserVisitPK userVisitPK, GetResponsibilityTypesForm form);
033    
034    CommandResult getResponsibilityType(UserVisitPK userVisitPK, GetResponsibilityTypeForm form);
035    
036    CommandResult getResponsibilityTypeChoices(UserVisitPK userVisitPK, GetResponsibilityTypeChoicesForm form);
037    
038    CommandResult setDefaultResponsibilityType(UserVisitPK userVisitPK, SetDefaultResponsibilityTypeForm form);
039    
040    CommandResult editResponsibilityType(UserVisitPK userVisitPK, EditResponsibilityTypeForm form);
041    
042    CommandResult deleteResponsibilityType(UserVisitPK userVisitPK, DeleteResponsibilityTypeForm form);
043    
044    // -------------------------------------------------------------------------
045    //   Responsibility Type Descriptions
046    // -------------------------------------------------------------------------
047    
048    CommandResult createResponsibilityTypeDescription(UserVisitPK userVisitPK, CreateResponsibilityTypeDescriptionForm form);
049    
050    CommandResult getResponsibilityTypeDescriptions(UserVisitPK userVisitPK, GetResponsibilityTypeDescriptionsForm form);
051    
052    CommandResult editResponsibilityTypeDescription(UserVisitPK userVisitPK, EditResponsibilityTypeDescriptionForm form);
053    
054    CommandResult deleteResponsibilityTypeDescription(UserVisitPK userVisitPK, DeleteResponsibilityTypeDescriptionForm form);
055    
056    // -------------------------------------------------------------------------
057    //   Skill Types
058    // -------------------------------------------------------------------------
059    
060    CommandResult createSkillType(UserVisitPK userVisitPK, CreateSkillTypeForm form);
061    
062    CommandResult getSkillTypes(UserVisitPK userVisitPK, GetSkillTypesForm form);
063    
064    CommandResult getSkillType(UserVisitPK userVisitPK, GetSkillTypeForm form);
065    
066    CommandResult getSkillTypeChoices(UserVisitPK userVisitPK, GetSkillTypeChoicesForm form);
067    
068    CommandResult setDefaultSkillType(UserVisitPK userVisitPK, SetDefaultSkillTypeForm form);
069    
070    CommandResult editSkillType(UserVisitPK userVisitPK, EditSkillTypeForm form);
071    
072    CommandResult deleteSkillType(UserVisitPK userVisitPK, DeleteSkillTypeForm form);
073    
074    // -------------------------------------------------------------------------
075    //   Skill Type Descriptions
076    // -------------------------------------------------------------------------
077    
078    CommandResult createSkillTypeDescription(UserVisitPK userVisitPK, CreateSkillTypeDescriptionForm form);
079    
080    CommandResult getSkillTypeDescriptions(UserVisitPK userVisitPK, GetSkillTypeDescriptionsForm form);
081    
082    CommandResult editSkillTypeDescription(UserVisitPK userVisitPK, EditSkillTypeDescriptionForm form);
083    
084    CommandResult deleteSkillTypeDescription(UserVisitPK userVisitPK, DeleteSkillTypeDescriptionForm form);
085    
086    // -------------------------------------------------------------------------
087    //   Leave Types
088    // -------------------------------------------------------------------------
089
090    CommandResult createLeaveType(UserVisitPK userVisitPK, CreateLeaveTypeForm form);
091
092    CommandResult getLeaveTypes(UserVisitPK userVisitPK, GetLeaveTypesForm form);
093
094    CommandResult getLeaveType(UserVisitPK userVisitPK, GetLeaveTypeForm form);
095
096    CommandResult getLeaveTypeChoices(UserVisitPK userVisitPK, GetLeaveTypeChoicesForm form);
097
098    CommandResult setDefaultLeaveType(UserVisitPK userVisitPK, SetDefaultLeaveTypeForm form);
099
100    CommandResult editLeaveType(UserVisitPK userVisitPK, EditLeaveTypeForm form);
101
102    CommandResult deleteLeaveType(UserVisitPK userVisitPK, DeleteLeaveTypeForm form);
103
104    // -------------------------------------------------------------------------
105    //   Leave Type Descriptions
106    // -------------------------------------------------------------------------
107
108    CommandResult createLeaveTypeDescription(UserVisitPK userVisitPK, CreateLeaveTypeDescriptionForm form);
109
110    CommandResult getLeaveTypeDescription(UserVisitPK userVisitPK, GetLeaveTypeDescriptionForm form);
111
112    CommandResult getLeaveTypeDescriptions(UserVisitPK userVisitPK, GetLeaveTypeDescriptionsForm form);
113
114    CommandResult editLeaveTypeDescription(UserVisitPK userVisitPK, EditLeaveTypeDescriptionForm form);
115
116    CommandResult deleteLeaveTypeDescription(UserVisitPK userVisitPK, DeleteLeaveTypeDescriptionForm form);
117    
118    // -------------------------------------------------------------------------
119    //   Leave Reasons
120    // -------------------------------------------------------------------------
121
122    CommandResult createLeaveReason(UserVisitPK userVisitPK, CreateLeaveReasonForm form);
123
124    CommandResult getLeaveReasons(UserVisitPK userVisitPK, GetLeaveReasonsForm form);
125
126    CommandResult getLeaveReason(UserVisitPK userVisitPK, GetLeaveReasonForm form);
127
128    CommandResult getLeaveReasonChoices(UserVisitPK userVisitPK, GetLeaveReasonChoicesForm form);
129
130    CommandResult setDefaultLeaveReason(UserVisitPK userVisitPK, SetDefaultLeaveReasonForm form);
131
132    CommandResult editLeaveReason(UserVisitPK userVisitPK, EditLeaveReasonForm form);
133
134    CommandResult deleteLeaveReason(UserVisitPK userVisitPK, DeleteLeaveReasonForm form);
135
136    // -------------------------------------------------------------------------
137    //   Leave Reason Descriptions
138    // -------------------------------------------------------------------------
139
140    CommandResult createLeaveReasonDescription(UserVisitPK userVisitPK, CreateLeaveReasonDescriptionForm form);
141
142    CommandResult getLeaveReasonDescription(UserVisitPK userVisitPK, GetLeaveReasonDescriptionForm form);
143
144    CommandResult getLeaveReasonDescriptions(UserVisitPK userVisitPK, GetLeaveReasonDescriptionsForm form);
145
146    CommandResult editLeaveReasonDescription(UserVisitPK userVisitPK, EditLeaveReasonDescriptionForm form);
147
148    CommandResult deleteLeaveReasonDescription(UserVisitPK userVisitPK, DeleteLeaveReasonDescriptionForm form);
149
150    // -------------------------------------------------------------------------
151    //   Leaves
152    // -------------------------------------------------------------------------
153
154    CommandResult createLeave(UserVisitPK userVisitPK, CreateLeaveForm form);
155
156    CommandResult getLeaveStatusChoices(UserVisitPK userVisitPK, GetLeaveStatusChoicesForm form);
157
158    CommandResult setLeaveStatus(UserVisitPK userVisitPK, SetLeaveStatusForm form);
159
160    CommandResult getLeaves(UserVisitPK userVisitPK, GetLeavesForm form);
161
162    CommandResult getLeave(UserVisitPK userVisitPK, GetLeaveForm form);
163
164    CommandResult editLeave(UserVisitPK userVisitPK, EditLeaveForm form);
165
166    CommandResult deleteLeave(UserVisitPK userVisitPK, DeleteLeaveForm form);
167
168    // -------------------------------------------------------------------------
169    //   Termination Reasons
170    // -------------------------------------------------------------------------
171
172    CommandResult createTerminationReason(UserVisitPK userVisitPK, CreateTerminationReasonForm form);
173
174    CommandResult getTerminationReasons(UserVisitPK userVisitPK, GetTerminationReasonsForm form);
175
176    CommandResult getTerminationReason(UserVisitPK userVisitPK, GetTerminationReasonForm form);
177
178    CommandResult getTerminationReasonChoices(UserVisitPK userVisitPK, GetTerminationReasonChoicesForm form);
179
180    CommandResult setDefaultTerminationReason(UserVisitPK userVisitPK, SetDefaultTerminationReasonForm form);
181
182    CommandResult editTerminationReason(UserVisitPK userVisitPK, EditTerminationReasonForm form);
183
184    CommandResult deleteTerminationReason(UserVisitPK userVisitPK, DeleteTerminationReasonForm form);
185
186    // -------------------------------------------------------------------------
187    //   Termination Reason Descriptions
188    // -------------------------------------------------------------------------
189
190    CommandResult createTerminationReasonDescription(UserVisitPK userVisitPK, CreateTerminationReasonDescriptionForm form);
191
192    CommandResult getTerminationReasonDescriptions(UserVisitPK userVisitPK, GetTerminationReasonDescriptionsForm form);
193
194    CommandResult editTerminationReasonDescription(UserVisitPK userVisitPK, EditTerminationReasonDescriptionForm form);
195
196    CommandResult deleteTerminationReasonDescription(UserVisitPK userVisitPK, DeleteTerminationReasonDescriptionForm form);
197
198    // -------------------------------------------------------------------------
199    //   Termination Types
200    // -------------------------------------------------------------------------
201    
202    CommandResult createTerminationType(UserVisitPK userVisitPK, CreateTerminationTypeForm form);
203    
204    CommandResult getTerminationTypes(UserVisitPK userVisitPK, GetTerminationTypesForm form);
205    
206    CommandResult getTerminationType(UserVisitPK userVisitPK, GetTerminationTypeForm form);
207    
208    CommandResult getTerminationTypeChoices(UserVisitPK userVisitPK, GetTerminationTypeChoicesForm form);
209    
210    CommandResult setDefaultTerminationType(UserVisitPK userVisitPK, SetDefaultTerminationTypeForm form);
211    
212    CommandResult editTerminationType(UserVisitPK userVisitPK, EditTerminationTypeForm form);
213    
214    CommandResult deleteTerminationType(UserVisitPK userVisitPK, DeleteTerminationTypeForm form);
215    
216    // -------------------------------------------------------------------------
217    //   Termination Type Descriptions
218    // -------------------------------------------------------------------------
219    
220    CommandResult createTerminationTypeDescription(UserVisitPK userVisitPK, CreateTerminationTypeDescriptionForm form);
221    
222    CommandResult getTerminationTypeDescriptions(UserVisitPK userVisitPK, GetTerminationTypeDescriptionsForm form);
223    
224    CommandResult editTerminationTypeDescription(UserVisitPK userVisitPK, EditTerminationTypeDescriptionForm form);
225    
226    CommandResult deleteTerminationTypeDescription(UserVisitPK userVisitPK, DeleteTerminationTypeDescriptionForm form);
227    
228    // -------------------------------------------------------------------------
229    //   Employments
230    // -------------------------------------------------------------------------
231
232    CommandResult createEmployment(UserVisitPK userVisitPK, CreateEmploymentForm form);
233
234    CommandResult getEmployments(UserVisitPK userVisitPK, GetEmploymentsForm form);
235
236    CommandResult getEmployment(UserVisitPK userVisitPK, GetEmploymentForm form);
237
238    CommandResult editEmployment(UserVisitPK userVisitPK, EditEmploymentForm form);
239
240    CommandResult deleteEmployment(UserVisitPK userVisitPK, DeleteEmploymentForm form);
241
242    // -------------------------------------------------------------------------
243    //   Party Responsibilities
244    // -------------------------------------------------------------------------
245    
246    CommandResult createPartyResponsibility(UserVisitPK userVisitPK, CreatePartyResponsibilityForm form);
247    
248    CommandResult getPartyResponsibilities(UserVisitPK userVisitPK, GetPartyResponsibilitiesForm form);
249    
250    CommandResult deletePartyResponsibility(UserVisitPK userVisitPK, DeletePartyResponsibilityForm form);
251    
252    // -------------------------------------------------------------------------
253    //   Party Skills
254    // -------------------------------------------------------------------------
255    
256    CommandResult createPartySkill(UserVisitPK userVisitPK, CreatePartySkillForm form);
257    
258    CommandResult getPartySkills(UserVisitPK userVisitPK, GetPartySkillsForm form);
259    
260    CommandResult deletePartySkill(UserVisitPK userVisitPK, DeletePartySkillForm form);
261    
262    // --------------------------------------------------------------------------------
263    //   Employee Types
264    // --------------------------------------------------------------------------------
265    
266    CommandResult createEmployeeType(UserVisitPK userVisitPK, CreateEmployeeTypeForm form);
267    
268    CommandResult getEmployeeTypeChoices(UserVisitPK userVisitPK, GetEmployeeTypeChoicesForm form);
269    
270    CommandResult getEmployeeType(UserVisitPK userVisitPK, GetEmployeeTypeForm form);
271    
272    CommandResult getEmployeeTypes(UserVisitPK userVisitPK, GetEmployeeTypesForm form);
273    
274    CommandResult setDefaultEmployeeType(UserVisitPK userVisitPK, SetDefaultEmployeeTypeForm form);
275    
276    CommandResult editEmployeeType(UserVisitPK userVisitPK, EditEmployeeTypeForm form);
277    
278    CommandResult deleteEmployeeType(UserVisitPK userVisitPK, DeleteEmployeeTypeForm form);
279    
280    // --------------------------------------------------------------------------------
281    //   Employee Type Descriptions
282    // --------------------------------------------------------------------------------
283    
284    CommandResult createEmployeeTypeDescription(UserVisitPK userVisitPK, CreateEmployeeTypeDescriptionForm form);
285    
286    CommandResult getEmployeeTypeDescriptions(UserVisitPK userVisitPK, GetEmployeeTypeDescriptionsForm form);
287    
288    CommandResult editEmployeeTypeDescription(UserVisitPK userVisitPK, EditEmployeeTypeDescriptionForm form);
289    
290    CommandResult deleteEmployeeTypeDescription(UserVisitPK userVisitPK, DeleteEmployeeTypeDescriptionForm form);
291    
292    // -------------------------------------------------------------------------
293    //   Employees
294    // -------------------------------------------------------------------------
295    
296    CommandResult getEmployee(UserVisitPK userVisitPK, GetEmployeeForm form);
297    
298    // -------------------------------------------------------------------------
299    //   Testing
300    // -------------------------------------------------------------------------
301    
302    String ping();
303        
304}