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