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.GetSequenceValueForm;
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.control.SequenceControl;
025import com.echothree.model.control.sequence.server.logic.SequenceLogic;
026import com.echothree.model.data.sequence.server.entity.Sequence;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSingleEntityCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetSequenceValueCommand
040        extends BaseSingleEntityCommand<Sequence, GetSequenceValueForm> {
041
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.SequenceValue.name(), SecurityRoles.Get.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("SequenceTypeName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("SequenceName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
057                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
058        );
059    }
060
061    @Inject
062    SequenceControl sequenceControl;
063
064    @Inject
065    SequenceLogic sequenceLogic;
066
067    /** Creates a new instance of GetSequenceValueCommand */
068    public GetSequenceValueCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071
072    @Override
073    protected Sequence getEntity() {
074        return sequenceLogic.getSequenceByUniversalSpec(this, form, false);
075    }
076
077    @Override
078    protected BaseResult getResult(Sequence sequence) {
079        var result = SequenceResultFactory.getGetSequenceValueResult();
080
081        if(!hasExecutionErrors()) {
082            var sequenceValue = sequenceControl.getSequenceValue(sequence);
083
084            result.setValue(sequenceValue.getValue());
085        }
086
087        return result;
088    }
089    
090}