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.server.command;
018
019import com.echothree.control.user.job.common.form.EndJobForm;
020import com.echothree.model.control.job.server.control.JobControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.data.user.common.pk.UserVisitPK;
023import com.echothree.util.common.message.ExecutionErrors;
024import com.echothree.util.common.validation.FieldDefinition;
025import com.echothree.util.common.validation.FieldType;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.server.control.BaseSimpleCommand;
028import com.echothree.util.server.control.CommandSecurityDefinition;
029import com.echothree.util.server.control.PartyTypeDefinition;
030import java.util.List;
031import javax.enterprise.context.Dependent;
032import javax.inject.Inject;
033
034@Dependent
035public class EndJobCommand
036        extends BaseSimpleCommand<EndJobForm> {
037    
038    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
043                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null)
044        ));
045        
046        FORM_FIELD_DEFINITIONS = List.of(
047                new FieldDefinition("JobName", FieldType.ENTITY_NAME, true, null, null)
048        );
049    }
050
051    @Inject
052    JobControl jobControl;
053
054    
055    /** Creates a new instance of EndJobCommand */
056    public EndJobCommand() {
057        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
058    }
059    
060    @Override
061    protected BaseResult execute() {
062        var jobName = form.getJobName();
063        var job = jobControl.getJobByName(jobName);
064        
065        if(job != null) {
066            var jobStatus = jobControl.getJobStatusForUpdate(job);
067            
068            jobStatus.setLastEndTime(session.getStartTime());
069        } else {
070            addExecutionError(ExecutionErrors.UnknownJobName.name(), jobName);
071        }
072        
073        return null;
074    }
075    
076}