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.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.control.sequence.server.logic.SequenceLogic;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
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 java.util.List;
034import javax.enterprise.context.Dependent;
035import javax.inject.Inject;
036
037@Dependent
038public class SetSequenceValueCommand
039        extends BaseSimpleCommand<SetSequenceValueForm> {
040
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.SequenceValue.name(), SecurityRoles.Set.name())
049                ))
050        ));
051
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("SequenceTypeName", FieldType.ENTITY_NAME, false, null, null),
054                new FieldDefinition("SequenceName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
056                new FieldDefinition("Uuid", FieldType.UUID, false, null, null),
057                new FieldDefinition("Value", FieldType.STRING, true, 1L, 40L)
058        );
059    }
060
061    @Inject
062    SequenceControl sequenceControl;
063
064    @Inject
065    SequenceLogic sequenceLogic;
066
067
068    /** Creates a new instance of SetSequenceValueCommand */
069    public SetSequenceValueCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072
073    @Override
074    protected BaseResult execute() {
075        var sequence = sequenceLogic.getSequenceByUniversalSpec(this, form, false);
076
077        if(!hasExecutionErrors()) {
078            var value = form.getValue();
079
080            if(value.length() == sequence.getLastDetail().getMask().length()) {
081                var sequenceValue = sequenceControl.getSequenceValueForUpdate(sequence);
082
083                if(sequenceValue == null) {
084                    sequenceControl.createSequenceValue(sequence, value);
085                } else {
086                    sequenceValue.setValue(value);
087                }
088            } else {
089                addExecutionError(ExecutionErrors.InvalidValueLength.name());
090            }
091        }
092
093        return null;
094    }
095    
096}