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.chain.server.command;
018
019import com.echothree.control.user.chain.common.form.CreateChainForm;
020import com.echothree.model.control.chain.server.control.ChainControl;
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.common.SequenceTypes;
025import com.echothree.model.control.sequence.server.control.SequenceControl;
026import com.echothree.model.data.sequence.server.entity.Sequence;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039
040@Dependent
041public class CreateChainCommand
042        extends BaseSimpleCommand<CreateChainForm> {
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(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                    new SecurityRoleDefinition(SecurityRoleGroups.Chain.name(), SecurityRoles.Create.name())
052                    ))
053                ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("ChainInstanceSequenceName", FieldType.ENTITY_NAME, 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("Description", FieldType.STRING, false, 1L, 132L)
063                );
064    }
065    
066    /** Creates a new instance of CreateChainCommand */
067    public CreateChainCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var chainControl = Session.getModelController(ChainControl.class);
074        var chainKindName = form.getChainKindName();
075        var chainKind = chainControl.getChainKindByName(chainKindName);
076
077        if(chainKind != null) {
078            var chainTypeName = form.getChainTypeName();
079            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
080
081            if(chainType != null) {
082                var chainName = form.getChainName();
083                var chain = chainControl.getChainByName(chainType, chainName);
084
085                if(chain == null) {
086                    var chainInstanceSequenceName = form.getChainInstanceSequenceName();
087                    Sequence chainInstanceSequence = null;
088
089                    if(chainInstanceSequenceName != null) {
090                        var sequenceControl = Session.getModelController(SequenceControl.class);
091                        var sequenceType = sequenceControl.getSequenceTypeByName(SequenceTypes.CHAIN_INSTANCE.name());
092
093                        chainInstanceSequence = sequenceControl.getSequenceByName(sequenceType, chainInstanceSequenceName);
094                    }
095
096                    if(chainInstanceSequenceName == null || chainInstanceSequence != null) {
097                        var partyPK = getPartyPK();
098                        var isDefault = Boolean.valueOf(form.getIsDefault());
099                        var sortOrder = Integer.valueOf(form.getSortOrder());
100                        var description = form.getDescription();
101
102                        chain = chainControl.createChain(chainType, chainName, chainInstanceSequence, isDefault, sortOrder, partyPK);
103
104                        if(description != null) {
105                            chainControl.createChainDescription(chain, getPreferredLanguage(), description, partyPK);
106                        }
107                    } else {
108                        addExecutionError(ExecutionErrors.UnknownChainInstanceSequenceName.name(), chainInstanceSequenceName);
109                    }
110                } else {
111                    addExecutionError(ExecutionErrors.DuplicateChainName.name(), chainKindName, chainTypeName, chainName);
112                }
113            } else {
114                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
115            }
116        } else {
117            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
118        }
119
120        return null;
121    }
122
123}