001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.job.common;
018
019import com.echothree.control.user.job.common.form.*;
020import com.echothree.control.user.job.common.result.*;
021import com.echothree.model.data.user.common.pk.UserVisitPK;
022import com.echothree.util.common.command.CommandResult;
023import com.echothree.util.common.command.VoidResult;
024
025public interface JobService
026        extends JobForms {
027    
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033    
034    // --------------------------------------------------------------------------------
035    //   Jobs
036    // --------------------------------------------------------------------------------
037    
038    CommandResult<VoidResult> createJob(UserVisitPK userVisitPK, CreateJobForm form);
039    
040    CommandResult<GetJobResult> getJob(UserVisitPK userVisitPK, GetJobForm form);
041    
042    CommandResult<GetJobsResult> getJobs(UserVisitPK userVisitPK, GetJobsForm form);
043    
044    CommandResult<GetJobStatusChoicesResult> getJobStatusChoices(UserVisitPK userVisitPK, GetJobStatusChoicesForm form);
045    
046    CommandResult<VoidResult> setJobStatus(UserVisitPK userVisitPK, SetJobStatusForm form);
047    
048    CommandResult<EditJobResult> editJob(UserVisitPK userVisitPK, EditJobForm form);
049    
050    CommandResult<VoidResult> deleteJob(UserVisitPK userVisitPK, DeleteJobForm form);
051    
052    CommandResult<VoidResult> startJob(UserVisitPK userVisitPK, StartJobForm form);
053    
054    CommandResult<VoidResult> endJob(UserVisitPK userVisitPK, EndJobForm form);
055    
056    // --------------------------------------------------------------------------------
057    //   Job Descriptions
058    // --------------------------------------------------------------------------------
059    
060    CommandResult<VoidResult> createJobDescription(UserVisitPK userVisitPK, CreateJobDescriptionForm form);
061    
062    CommandResult<GetJobDescriptionsResult> getJobDescriptions(UserVisitPK userVisitPK, GetJobDescriptionsForm form);
063    
064    CommandResult<EditJobDescriptionResult> editJobDescription(UserVisitPK userVisitPK, EditJobDescriptionForm form);
065    
066    CommandResult<VoidResult> deleteJobDescription(UserVisitPK userVisitPK, DeleteJobDescriptionForm form);
067    
068}