001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.form.SetSequenceValueForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.control.sequence.server.control.SequenceControl;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class SetSequenceValueCommand
041        extends BaseSimpleCommand<SetSequenceValueForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047       COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                    new SecurityRoleDefinition(SecurityRoleGroups.Sequence.name(), SecurityRoles.Edit.name())
051                    )))
052                )));
053
054         FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("SequenceTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("SequenceName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("Value", FieldType.STRING, true, 1L, 40L)
058                ));
059    }
060    
061    /** Creates a new instance of SetSequenceValueCommand */
062    public SetSequenceValueCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var sequenceControl = Session.getModelController(SequenceControl.class);
069        var sequenceTypeName = form.getSequenceTypeName();
070        var sequenceType = sequenceControl.getSequenceTypeByName(sequenceTypeName);
071        
072        if(sequenceType != null) {
073            var sequenceName = form.getSequenceName();
074            var sequence = sequenceControl.getSequenceByName(sequenceType, sequenceName);
075            
076            if(sequence != null) {
077                var value = form.getValue();
078                if(value.length() == sequence.getLastDetail().getMask().length()) {
079                    var sequenceValue = sequenceControl.getSequenceValueForUpdate(sequence);
080                    
081                    if(sequenceValue == null) {
082                        sequenceControl.createSequenceValue(sequence, value);
083                    } else {
084                        sequenceValue.setValue(value);
085                    }
086                } else {
087                    addExecutionError(ExecutionErrors.InvalidValueLength.name());
088                }
089            } else {
090                addExecutionError(ExecutionErrors.UnknownSequenceName.name(), sequenceName);
091            }
092        } else {
093            addExecutionError(ExecutionErrors.UnknownSequenceTypeName.name(), sequenceTypeName);
094        }
095        
096        return null;
097    }
098    
099}