001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class CreateSequenceCommand
042        extends BaseSimpleCommand<CreateSequenceForm> {
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.Create.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, false, null, null),
058                new FieldDefinition("Mask", FieldType.SEQUENCE_MASK, true, null, null),
059                new FieldDefinition("ChunkSize", FieldType.UNSIGNED_INTEGER, false, null, null),
060                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
061                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
062                new FieldDefinition("Value", FieldType.STRING, false, 1L, 40L),
063                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
064                ));
065    }
066    
067    /** Creates a new instance of CreateSequenceCommand */
068    public CreateSequenceCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var result = SequenceResultFactory.getCreateSequenceResult();
075        var sequenceTypeName = form.getSequenceTypeName();
076        var sequenceType = SequenceTypeLogic.getInstance().getSequenceTypeByName(this, sequenceTypeName);
077        Sequence sequence = null;
078
079        if(!hasExecutionErrors()) {
080            var sequenceName = form.getSequenceName();
081            var mask = form.getMask();
082            var value = form.getValue();
083            var rawChunkSize = form.getChunkSize();
084            var chunkSize = rawChunkSize == null? null: Integer.valueOf(rawChunkSize);
085            var isDefault = Boolean.valueOf(form.getIsDefault());
086            var sortOrder = Integer.valueOf(form.getSortOrder());
087            var description = form.getDescription();
088
089            sequence = SequenceLogic.getInstance().createSequence(this, sequenceType, sequenceName, value, mask, chunkSize, isDefault,
090                    sortOrder, description, getPreferredLanguage(), getPartyPK());
091        }
092
093        if(sequence != null && !hasExecutionErrors()) {
094            result.setSequenceName(sequence.getLastDetail().getSequenceName());
095            result.setEntityRef(sequence.getPrimaryKey().getEntityRef());
096        }
097
098        return result;
099    }
100    
101}