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.CreateSequenceForm;
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.SequenceLogic;
025import com.echothree.model.control.sequence.server.logic.SequenceTypeLogic;
026import com.echothree.model.data.sequence.server.entity.Sequence;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class CreateSequenceCommand
041        extends BaseSimpleCommand<CreateSequenceForm> {
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(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.Sequence.name(), SecurityRoles.Create.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("SequenceTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("SequenceName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("Mask", FieldType.SEQUENCE_MASK, true, null, null),
058                new FieldDefinition("ChunkSize", FieldType.UNSIGNED_INTEGER, false, null, null),
059                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
060                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
061                new FieldDefinition("Value", FieldType.STRING, false, 1L, 40L),
062                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
063        );
064    }
065
066    @Inject
067    SequenceLogic sequenceLogic;
068
069    @Inject
070    SequenceTypeLogic sequenceTypeLogic;
071
072    
073    /** Creates a new instance of CreateSequenceCommand */
074    public CreateSequenceCommand() {
075        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
076    }
077    
078    @Override
079    protected BaseResult execute() {
080        var result = SequenceResultFactory.getCreateSequenceResult();
081        var sequenceTypeName = form.getSequenceTypeName();
082        var sequenceType = sequenceTypeLogic.getSequenceTypeByName(this, sequenceTypeName);
083        Sequence sequence = null;
084
085        if(!hasExecutionErrors()) {
086            var sequenceName = form.getSequenceName();
087            var mask = form.getMask();
088            var value = form.getValue();
089            var rawChunkSize = form.getChunkSize();
090            var chunkSize = rawChunkSize == null? null: Integer.valueOf(rawChunkSize);
091            var isDefault = Boolean.valueOf(form.getIsDefault());
092            var sortOrder = Integer.valueOf(form.getSortOrder());
093            var description = form.getDescription();
094
095            sequence = sequenceLogic.createSequence(this, sequenceType, sequenceName, value, mask, chunkSize, isDefault,
096                    sortOrder, description, getPreferredLanguage(), getPartyPK());
097        }
098
099        if(sequence != null && !hasExecutionErrors()) {
100            result.setSequenceName(sequence.getLastDetail().getSequenceName());
101            result.setEntityRef(sequence.getPrimaryKey().getEntityRef());
102        }
103
104        return result;
105    }
106    
107}