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.CreateJobForm;
020import com.echothree.model.control.job.server.control.JobControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.job.common.workflow.JobStatusConstants;
026import com.echothree.model.control.workflow.server.control.WorkflowControl;
027import com.echothree.model.data.core.server.entity.EntityInstance;
028import com.echothree.model.data.job.server.entity.Job;
029import com.echothree.model.data.party.common.pk.PartyPK;
030import com.echothree.model.data.party.server.entity.Party;
031import com.echothree.model.data.party.server.entity.PartyType;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.BaseResult;
037import com.echothree.util.server.control.BaseSimpleCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import com.echothree.util.server.persistence.Session;
042import java.util.Arrays;
043import java.util.Collections;
044import java.util.List;
045
046public class CreateJobCommand
047        extends BaseSimpleCommand<CreateJobForm> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
056                    new SecurityRoleDefinition(SecurityRoleGroups.Job.name(), SecurityRoles.Create.name())
057                    )))
058                )));
059        
060        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
061                new FieldDefinition("JobName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
063                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
064                ));
065    }
066    
067    /** Creates a new instance of CreateJobCommand */
068    public CreateJobCommand(UserVisitPK userVisitPK, CreateJobForm form) {
069        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var jobControl = Session.getModelController(JobControl.class);
075        String jobName = form.getJobName();
076        Job job = jobControl.getJobByName(jobName);
077        
078        if(job == null) {
079            var partyControl = Session.getModelController(PartyControl.class);
080            Party runAsParty = partyControl.getPartyByName(jobName);
081            
082            if(runAsParty == null) {
083                var coreControl = getCoreControl();
084                var workflowControl = Session.getModelController(WorkflowControl.class);
085                PartyType partyType = partyControl.getPartyTypeByName(PartyTypes.UTILITY.name());
086                var sortOrder = Integer.valueOf(form.getSortOrder());
087                var description = form.getDescription();
088                PartyPK createdBy = getPartyPK();
089                
090                runAsParty = partyControl.createParty(jobName, partyType, null, null, null, null, null);
091                job = jobControl.createJob(jobName, runAsParty, sortOrder, createdBy);
092                
093                if(description != null) {
094                    jobControl.createJobDescription(job, getPreferredLanguage(), description, createdBy);
095                }
096                
097                EntityInstance entityInstance = coreControl.getEntityInstanceByBasePK(job.getPrimaryKey());
098                workflowControl.addEntityToWorkflowUsingNames(null, JobStatusConstants.Workflow_JOB_STATUS, JobStatusConstants.WorkflowEntrance_NEW_ENABLED, entityInstance, null, null, createdBy);
099            } else {
100                addExecutionError(ExecutionErrors.DuplicatePartyName.name(), jobName);
101            }
102        } else {
103            addExecutionError(ExecutionErrors.DuplicateJobName.name(), jobName);
104        }
105        
106        return null;
107    }
108    
109}