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