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.sequence.server.command;
018
019import com.echothree.control.user.sequence.common.edit.SequenceDescriptionEdit;
020import com.echothree.control.user.sequence.common.edit.SequenceEditFactory;
021import com.echothree.control.user.sequence.common.form.EditSequenceDescriptionForm;
022import com.echothree.control.user.sequence.common.result.EditSequenceDescriptionResult;
023import com.echothree.control.user.sequence.common.result.SequenceResultFactory;
024import com.echothree.control.user.sequence.common.spec.SequenceDescriptionSpec;
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.sequence.server.control.SequenceControl;
030import com.echothree.model.data.sequence.server.entity.Sequence;
031import com.echothree.model.data.sequence.server.entity.SequenceDescription;
032import com.echothree.model.data.sequence.server.entity.SequenceType;
033import com.echothree.model.data.user.common.pk.UserVisitPK;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.common.command.EditMode;
038import com.echothree.util.server.control.BaseAbstractEditCommand;
039import com.echothree.util.server.control.CommandSecurityDefinition;
040import com.echothree.util.server.control.PartyTypeDefinition;
041import com.echothree.util.server.control.SecurityRoleDefinition;
042import java.util.List;
043import javax.enterprise.context.Dependent;
044import javax.inject.Inject;
045
046@Dependent
047public class EditSequenceDescriptionCommand
048        extends BaseAbstractEditCommand<SequenceDescriptionSpec, SequenceDescriptionEdit, EditSequenceDescriptionResult, SequenceDescription, Sequence> {
049
050    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
051    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
052    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
053
054    static {
055        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
056                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
057                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
058                        new SecurityRoleDefinition(SecurityRoleGroups.Sequence.name(), SecurityRoles.Description.name())
059                ))
060        ));
061
062        SPEC_FIELD_DEFINITIONS = List.of(
063                new FieldDefinition("SequenceTypeName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("SequenceName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
066        );
067
068        EDIT_FIELD_DEFINITIONS = List.of(
069                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
070        );
071    }
072
073    @Inject
074    PartyControl partyControl;
075
076    @Inject
077    SequenceControl sequenceControl;
078
079    /** Creates a new instance of EditSequenceDescriptionCommand */
080    public EditSequenceDescriptionCommand() {
081        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
082    }
083
084    @Override
085    public EditSequenceDescriptionResult getResult() {
086        return SequenceResultFactory.getEditSequenceDescriptionResult();
087    }
088
089    @Override
090    public SequenceDescriptionEdit getEdit() {
091        return SequenceEditFactory.getSequenceDescriptionEdit();
092    }
093
094    SequenceType sequenceType;
095    
096    @Override
097    public SequenceDescription getEntity(EditSequenceDescriptionResult result) {
098        SequenceDescription sequenceDescription = null;
099        var sequenceTypeName = spec.getSequenceTypeName();
100        
101        sequenceType = sequenceControl.getSequenceTypeByName(sequenceTypeName);
102
103        if(sequenceType != null) {
104            var sequenceName = spec.getSequenceName();
105            var sequence = sequenceControl.getSequenceByName(sequenceType, sequenceName);
106
107            if(sequence != null) {
108                var languageIsoName = spec.getLanguageIsoName();
109                var language = partyControl.getLanguageByIsoName(languageIsoName);
110
111                if(language != null) {
112                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
113                        sequenceDescription = sequenceControl.getSequenceDescription(sequence, language);
114                    } else { // EditMode.UPDATE
115                        sequenceDescription = sequenceControl.getSequenceDescriptionForUpdate(sequence, language);
116                    }
117
118                    if(sequenceDescription == null) {
119                        addExecutionError(ExecutionErrors.UnknownSequenceDescription.name(), sequenceTypeName, sequenceName, languageIsoName);
120                    }
121                } else {
122                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
123                }
124            } else {
125                addExecutionError(ExecutionErrors.UnknownSequenceName.name(), sequenceTypeName, sequenceName);
126            }
127        } else {
128            addExecutionError(ExecutionErrors.UnknownSequenceTypeName.name(), sequenceTypeName);
129        }
130
131        return sequenceDescription;
132    }
133
134    @Override
135    public Sequence getLockEntity(SequenceDescription sequenceDescription) {
136        return sequenceDescription.getSequence();
137    }
138
139    @Override
140    public void fillInResult(EditSequenceDescriptionResult result, SequenceDescription sequenceDescription) {
141        result.setSequenceDescription(sequenceControl.getSequenceDescriptionTransfer(getUserVisit(), sequenceDescription));
142    }
143
144    @Override
145    public void doLock(SequenceDescriptionEdit edit, SequenceDescription sequenceDescription) {
146        edit.setDescription(sequenceDescription.getDescription());
147    }
148
149    @Override
150    public void doUpdate(SequenceDescription sequenceDescription) {
151        var sequenceDescriptionValue = sequenceControl.getSequenceDescriptionValue(sequenceDescription);
152        
153        sequenceDescriptionValue.setDescription(edit.getDescription());
154        
155        sequenceControl.updateSequenceDescriptionFromValue(sequenceDescriptionValue, getPartyPK());
156    }
157
158}