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.GetNextSequenceValueForm;
020import com.echothree.control.user.sequence.common.result.SequenceResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.sequence.server.logic.SequenceGeneratorLogic;
025import com.echothree.model.control.sequence.server.logic.SequenceLogic;
026import com.echothree.util.common.command.BaseResult;
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 GetNextSequenceValueCommand
039        extends BaseSimpleCommand<GetNextSequenceValueForm> {
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.GetNext.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         );
058    }
059
060    /** Creates a new instance of SetSequenceValueCommand */
061    public GetNextSequenceValueCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064
065    @Inject
066    SequenceLogic sequenceLogic;
067
068    @Inject
069    SequenceGeneratorLogic sequenceGeneratorLogic;
070
071    @Override
072    protected BaseResult execute() {
073        var result = SequenceResultFactory.getGetNextSequenceValueResult();
074        var sequence = sequenceLogic.getSequenceByUniversalSpec(this, form, false);
075
076        if(!hasExecutionErrors()) {
077            result.setValue(sequenceGeneratorLogic.getNextSequenceValue(sequence));
078        }
079
080        return result;
081    }
082    
083}