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