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.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;
038
039public class CreateSequenceCommand
040        extends BaseSimpleCommand<CreateSequenceForm> {
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(Collections.unmodifiableList(Arrays.asList(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
049                    new SecurityRoleDefinition(SecurityRoleGroups.Sequence.name(), SecurityRoles.Create.name())
050                    )))
051                )));
052
053        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054                new FieldDefinition("SequenceTypeName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("SequenceName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("Mask", FieldType.SEQUENCE_MASK, true, null, null),
057                new FieldDefinition("ChunkSize", FieldType.UNSIGNED_INTEGER, false, null, null),
058                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
059                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
060                new FieldDefinition("Value", FieldType.STRING, false, 1L, 40L),
061                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
062                ));
063    }
064    
065    /** Creates a new instance of CreateSequenceCommand */
066    public CreateSequenceCommand(UserVisitPK userVisitPK, CreateSequenceForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var result = SequenceResultFactory.getCreateSequenceResult();
073        var sequenceTypeName = form.getSequenceTypeName();
074        var sequenceType = SequenceTypeLogic.getInstance().getSequenceTypeByName(this, sequenceTypeName);
075        Sequence sequence = null;
076
077        if(!hasExecutionErrors()) {
078            var sequenceName = form.getSequenceName();
079            var mask = form.getMask();
080            var value = form.getValue();
081            var rawChunkSize = form.getChunkSize();
082            var chunkSize = rawChunkSize == null? null: Integer.valueOf(rawChunkSize);
083            var isDefault = Boolean.valueOf(form.getIsDefault());
084            var sortOrder = Integer.valueOf(form.getSortOrder());
085            var description = form.getDescription();
086
087            sequence = SequenceLogic.getInstance().createSequence(this, sequenceType, sequenceName, value, mask, chunkSize, isDefault,
088                    sortOrder, description, getPreferredLanguage(), getPartyPK());
089        }
090
091        if(sequence != null && !hasExecutionErrors()) {
092            result.setSequenceName(sequence.getLastDetail().getSequenceName());
093            result.setEntityRef(sequence.getPrimaryKey().getEntityRef());
094        }
095
096        return result;
097    }
098    
099}