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.workflow.server.command;
018
019import com.echothree.control.user.workflow.common.edit.WorkflowEditFactory;
020import com.echothree.control.user.workflow.common.edit.WorkflowEntranceDescriptionEdit;
021import com.echothree.control.user.workflow.common.form.EditWorkflowEntranceDescriptionForm;
022import com.echothree.control.user.workflow.common.result.EditWorkflowEntranceDescriptionResult;
023import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
024import com.echothree.control.user.workflow.common.spec.WorkflowEntranceDescriptionSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.control.workflow.server.control.WorkflowControl;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.model.data.workflow.server.entity.Workflow;
033import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;
034import com.echothree.model.data.workflow.server.entity.WorkflowEntranceDescription;
035import com.echothree.model.data.workflow.server.value.WorkflowEntranceDescriptionValue;
036import com.echothree.util.common.message.ExecutionErrors;
037import com.echothree.util.common.validation.FieldDefinition;
038import com.echothree.util.common.validation.FieldType;
039import com.echothree.util.common.command.BaseResult;
040import com.echothree.util.common.command.EditMode;
041import com.echothree.util.server.control.BaseEditCommand;
042import com.echothree.util.server.control.CommandSecurityDefinition;
043import com.echothree.util.server.control.PartyTypeDefinition;
044import com.echothree.util.server.control.SecurityRoleDefinition;
045import com.echothree.util.server.persistence.Session;
046import java.util.Arrays;
047import java.util.Collections;
048import java.util.List;
049
050public class EditWorkflowEntranceDescriptionCommand
051        extends BaseEditCommand<WorkflowEntranceDescriptionSpec, WorkflowEntranceDescriptionEdit> {
052    
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056    
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
061                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowEntrance.name(), SecurityRoles.Description.name())
062                        )))
063                )));
064        
065        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("WorkflowEntranceName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
069                ));
070        
071        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
072                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
073                ));
074    }
075    
076    /** Creates a new instance of EditWorkflowEntranceDescriptionCommand */
077    public EditWorkflowEntranceDescriptionCommand(UserVisitPK userVisitPK, EditWorkflowEntranceDescriptionForm form) {
078        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    protected BaseResult execute() {
083        var workflowControl = Session.getModelController(WorkflowControl.class);
084        EditWorkflowEntranceDescriptionResult result = WorkflowResultFactory.getEditWorkflowEntranceDescriptionResult();
085        String workflowName = spec.getWorkflowName();
086        var workflow = workflowControl.getWorkflowByName(workflowName);
087        
088        if(workflow != null) {
089            String workflowEntranceName = spec.getWorkflowEntranceName();
090            WorkflowEntrance workflowEntrance = workflowControl.getWorkflowEntranceByName(workflow, workflowEntranceName);
091            
092            if(workflowEntrance != null) {
093                var partyControl = Session.getModelController(PartyControl.class);
094                String languageIsoName = spec.getLanguageIsoName();
095                Language language = partyControl.getLanguageByIsoName(languageIsoName);
096                
097                if(language != null) {
098                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
099                        WorkflowEntranceDescription workflowEntranceDescription = workflowControl.getWorkflowEntranceDescription(workflowEntrance, language);
100                        
101                        if(workflowEntranceDescription != null) {
102                            if(editMode.equals(EditMode.LOCK)) {
103                                result.setWorkflowEntranceDescription(workflowControl.getWorkflowEntranceDescriptionTransfer(getUserVisit(), workflowEntranceDescription));
104
105                                if(lockEntity(workflowEntrance)) {
106                                    WorkflowEntranceDescriptionEdit edit = WorkflowEditFactory.getWorkflowEntranceDescriptionEdit();
107
108                                    result.setEdit(edit);
109                                    edit.setDescription(workflowEntranceDescription.getDescription());
110                                } else {
111                                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
112                                }
113
114                                result.setEntityLock(getEntityLockTransfer(workflowEntrance));
115                            } else { // EditMode.ABANDON
116                                unlockEntity(workflowEntrance);
117                            }
118                        } else {
119                            addExecutionError(ExecutionErrors.UnknownWorkflowEntranceDescription.name());
120                        }
121                    } else if(editMode.equals(EditMode.UPDATE)) {
122                        WorkflowEntranceDescriptionValue workflowEntranceDescriptionValue = workflowControl.getWorkflowEntranceDescriptionValueForUpdate(workflowEntrance, language);
123                        
124                        if(workflowEntranceDescriptionValue != null) {
125                            if(lockEntityForUpdate(workflowEntrance)) {
126                                try {
127                                    String description = edit.getDescription();
128                                    
129                                    workflowEntranceDescriptionValue.setDescription(description);
130                                    
131                                    workflowControl.updateWorkflowEntranceDescriptionFromValue(workflowEntranceDescriptionValue, getPartyPK());
132                                } finally {
133                                    unlockEntity(workflowEntrance);
134                                }
135                            } else {
136                                addExecutionError(ExecutionErrors.EntityLockStale.name());
137                            }
138                        } else {
139                            addExecutionError(ExecutionErrors.UnknownWorkflowEntranceDescription.name());
140                        }
141                    }
142                } else {
143                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
144                }
145            } else {
146                addExecutionError(ExecutionErrors.UnknownWorkflowEntranceName.name(), workflowEntranceName);
147            }
148        } else {
149            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
150        }
151        
152        return result;
153    }
154    
155}