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.workflow.server.command;
018
019import com.echothree.control.user.workflow.common.edit.WorkflowEditFactory;
020import com.echothree.control.user.workflow.common.edit.WorkflowStepDescriptionEdit;
021import com.echothree.control.user.workflow.common.result.EditWorkflowStepDescriptionResult;
022import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
023import com.echothree.control.user.workflow.common.spec.WorkflowStepDescriptionSpec;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.party.server.control.PartyControl;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.workflow.server.control.WorkflowControl;
029import com.echothree.model.data.workflow.server.entity.WorkflowStep;
030import com.echothree.model.data.workflow.server.entity.WorkflowStepDescription;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditWorkflowStepDescriptionCommand
045        extends BaseAbstractEditCommand<WorkflowStepDescriptionSpec, WorkflowStepDescriptionEdit, EditWorkflowStepDescriptionResult, WorkflowStepDescription, WorkflowStep> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowStep.name(), SecurityRoles.Description.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
063        );
064        
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
067        );
068    }
069
070    @Inject
071    PartyControl partyControl;
072
073    @Inject
074    WorkflowControl workflowControl;
075
076    /** Creates a new instance of EditWorkflowStepDescriptionCommand */
077    public EditWorkflowStepDescriptionCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080
081    @Override
082    public EditWorkflowStepDescriptionResult getResult() {
083        return WorkflowResultFactory.getEditWorkflowStepDescriptionResult();
084    }
085
086    @Override
087    public WorkflowStepDescriptionEdit getEdit() {
088        return WorkflowEditFactory.getWorkflowStepDescriptionEdit();
089    }
090
091    @Override
092    public WorkflowStepDescription getEntity(EditWorkflowStepDescriptionResult result) {
093        WorkflowStepDescription workflowStepDescription = null;
094        var workflowName = spec.getWorkflowName();
095        var workflow = workflowControl.getWorkflowByName(workflowName);
096
097        if(workflow != null) {
098            var workflowStepName = spec.getWorkflowStepName();
099            var workflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
100
101            if(workflowStep != null) {
102                var languageIsoName = spec.getLanguageIsoName();
103                var language = partyControl.getLanguageByIsoName(languageIsoName);
104
105                if(language != null) {
106                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
107                        workflowStepDescription = workflowControl.getWorkflowStepDescription(workflowStep, language);
108                    } else { // EditMode.UPDATE
109                        workflowStepDescription = workflowControl.getWorkflowStepDescriptionForUpdate(workflowStep, language);
110                    }
111
112                    if(workflowStepDescription == null) {
113                        addExecutionError(ExecutionErrors.UnknownWorkflowStepDescription.name(), workflowName, workflowStepName, languageIsoName);
114                    }
115                } else {
116                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
117                }
118            } else {
119                addExecutionError(ExecutionErrors.UnknownWorkflowStepName.name(), workflowName, workflowStepName);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
123        }
124
125        return workflowStepDescription;
126    }
127
128    @Override
129    public WorkflowStep getLockEntity(WorkflowStepDescription workflowStepDescription) {
130        return workflowStepDescription.getWorkflowStep();
131    }
132
133    @Override
134    public void fillInResult(EditWorkflowStepDescriptionResult result, WorkflowStepDescription workflowStepDescription) {
135        result.setWorkflowStepDescription(workflowControl.getWorkflowStepDescriptionTransfer(getUserVisit(), workflowStepDescription));
136    }
137
138    @Override
139    public void doLock(WorkflowStepDescriptionEdit edit, WorkflowStepDescription workflowStepDescription) {
140        edit.setDescription(workflowStepDescription.getDescription());
141    }
142
143    @Override
144    public void doUpdate(WorkflowStepDescription workflowStepDescription) {
145        var workflowStepDescriptionValue = workflowControl.getWorkflowStepDescriptionValue(workflowStepDescription);
146
147        workflowStepDescriptionValue.setDescription(edit.getDescription());
148
149        workflowControl.updateWorkflowStepDescriptionFromValue(workflowStepDescriptionValue, getPartyPK());
150    }
151    
152}