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.SequenceEdit;
020import com.echothree.control.user.sequence.common.edit.SequenceEditFactory;
021import com.echothree.control.user.sequence.common.form.EditSequenceForm;
022import com.echothree.control.user.sequence.common.result.EditSequenceResult;
023import com.echothree.control.user.sequence.common.result.SequenceResultFactory;
024import com.echothree.control.user.sequence.common.spec.SequenceSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.sequence.server.control.SequenceControl;
029import com.echothree.model.data.sequence.server.entity.Sequence;
030import com.echothree.model.data.sequence.server.entity.SequenceType;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.EditMode;
036import com.echothree.util.server.control.BaseAbstractEditCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class EditSequenceCommand
046        extends BaseAbstractEditCommand<SequenceSpec, SequenceEdit, EditSequenceResult, Sequence, Sequence> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
050    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
056                        new SecurityRoleDefinition(SecurityRoleGroups.Sequence.name(), SecurityRoles.Edit.name())
057                ))
058        ));
059        
060        SPEC_FIELD_DEFINITIONS = List.of(
061                new FieldDefinition("SequenceTypeName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("SequenceName", FieldType.ENTITY_NAME, true, null, null)
063        );
064        
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("SequenceName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("Mask", FieldType.SEQUENCE_MASK, true, null, null),
068                new FieldDefinition("ChunkSize", FieldType.UNSIGNED_INTEGER, false, null, null),
069                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
070                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
071                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
072        );
073    }
074
075    @Inject
076    SequenceControl sequenceControl;
077
078    
079    /** Creates a new instance of EditSequenceCommand */
080    public EditSequenceCommand() {
081        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
082    }
083    
084    @Override
085    public EditSequenceResult getResult() {
086        return SequenceResultFactory.getEditSequenceResult();
087    }
088    
089    @Override
090    public SequenceEdit getEdit() {
091        return SequenceEditFactory.getSequenceEdit();
092    }
093    
094    SequenceType sequenceType = null;
095    
096    @Override
097    public Sequence getEntity(EditSequenceResult result) {
098        Sequence sequence = null;
099        var sequenceTypeName = spec.getSequenceTypeName();
100        
101        sequenceType = sequenceControl.getSequenceTypeByName(sequenceTypeName);
102        
103        if(sequenceType != null) {
104            var sequenceName = spec.getSequenceName();
105
106            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
107                sequence = sequenceControl.getSequenceByName(sequenceType, sequenceName);
108            } else { // EditMode.UPDATE
109                sequence = sequenceControl.getSequenceByNameForUpdate(sequenceType, sequenceName);
110            }
111
112            if(sequence != null) {
113                result.setSequence(sequenceControl.getSequenceTransfer(getUserVisit(), sequence));
114            } else {
115                addExecutionError(ExecutionErrors.UnknownSequenceName.name(), sequenceTypeName, sequenceTypeName, sequenceName);
116            }
117        } else {
118            addExecutionError(ExecutionErrors.UnknownSequenceTypeName.name(), sequenceTypeName);
119        }
120
121        return sequence;
122    }
123    
124    @Override
125    public Sequence getLockEntity(Sequence sequence) {
126        return sequence;
127    }
128    
129    @Override
130    public void fillInResult(EditSequenceResult result, Sequence sequence) {
131        result.setSequence(sequenceControl.getSequenceTransfer(getUserVisit(), sequence));
132    }
133    
134    @Override
135    public void doLock(SequenceEdit edit, Sequence sequence) {
136        var sequenceDescription = sequenceControl.getSequenceDescription(sequence, getPreferredLanguage());
137        var sequenceDetail = sequence.getLastDetail();
138        var chunkSize = sequenceDetail.getChunkSize();
139
140        edit.setSequenceName(sequenceDetail.getSequenceName());
141        edit.setMask(sequenceDetail.getMask());
142        edit.setChunkSize(chunkSize == null? null: chunkSize.toString());
143        edit.setIsDefault(sequenceDetail.getIsDefault().toString());
144        edit.setSortOrder(sequenceDetail.getSortOrder().toString());
145
146        if(sequenceDescription != null) {
147            edit.setDescription(sequenceDescription.getDescription());
148        }
149    }
150    
151    @Override
152    public void canUpdate(Sequence sequence) {
153        var sequenceName = edit.getSequenceName();
154        var duplicateSequence = sequenceControl.getSequenceByName(sequenceType, sequenceName);
155
156        if(duplicateSequence != null && !sequence.equals(duplicateSequence)) {
157            addExecutionError(ExecutionErrors.DuplicateSequenceName.name(), sequenceType.getLastDetail().getSequenceTypeName(), sequenceName);
158        }
159    }
160    
161    @Override
162    public void doUpdate(Sequence sequence) {
163        var partyPK = getPartyPK();
164        var sequenceDetailValue = sequenceControl.getSequenceDetailValueForUpdate(sequence);
165        var sequenceDescription = sequenceControl.getSequenceDescriptionForUpdate(sequence, getPreferredLanguage());
166        var rawChunkSize = edit.getChunkSize();
167        var chunkSize = rawChunkSize == null? null: Integer.valueOf(rawChunkSize);
168        var description = edit.getDescription();
169
170        sequenceDetailValue.setSequenceName(edit.getSequenceName());
171        sequenceDetailValue.setMask(edit.getMask());
172        sequenceDetailValue.setChunkSize(chunkSize);
173        sequenceDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
174        sequenceDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
175
176        sequenceControl.updateSequenceFromValue(sequenceDetailValue, partyPK);
177
178        if(sequenceDescription == null && description != null) {
179            sequenceControl.createSequenceDescription(sequence, getPreferredLanguage(), description, partyPK);
180        } else if(sequenceDescription != null && description == null) {
181            sequenceControl.deleteSequenceDescription(sequenceDescription, partyPK);
182        } else if(sequenceDescription != null && description != null) {
183            var sequenceDescriptionValue = sequenceControl.getSequenceDescriptionValue(sequenceDescription);
184
185            sequenceDescriptionValue.setDescription(description);
186            sequenceControl.updateSequenceDescriptionFromValue(sequenceDescriptionValue, partyPK);
187        }
188    }
189    
190}