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.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.Arrays;
038import java.util.Collections;
039import java.util.List;
040import javax.enterprise.context.RequestScoped;
041
042@RequestScoped
043public class CreateChainCommand
044        extends BaseSimpleCommand<CreateChainForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                    new SecurityRoleDefinition(SecurityRoleGroups.Chain.name(), SecurityRoles.Create.name())
054                    )))
055                )));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("ChainInstanceSequenceName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
063                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
064                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
065                ));
066    }
067    
068    /** Creates a new instance of CreateChainCommand */
069    public CreateChainCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var chainControl = Session.getModelController(ChainControl.class);
076        var chainKindName = form.getChainKindName();
077        var chainKind = chainControl.getChainKindByName(chainKindName);
078
079        if(chainKind != null) {
080            var chainTypeName = form.getChainTypeName();
081            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
082
083            if(chainType != null) {
084                var chainName = form.getChainName();
085                var chain = chainControl.getChainByName(chainType, chainName);
086
087                if(chain == null) {
088                    var chainInstanceSequenceName = form.getChainInstanceSequenceName();
089                    Sequence chainInstanceSequence = null;
090
091                    if(chainInstanceSequenceName != null) {
092                        var sequenceControl = Session.getModelController(SequenceControl.class);
093                        var sequenceType = sequenceControl.getSequenceTypeByName(SequenceTypes.CHAIN_INSTANCE.name());
094
095                        chainInstanceSequence = sequenceControl.getSequenceByName(sequenceType, chainInstanceSequenceName);
096                    }
097
098                    if(chainInstanceSequenceName == null || chainInstanceSequence != null) {
099                        var partyPK = getPartyPK();
100                        var isDefault = Boolean.valueOf(form.getIsDefault());
101                        var sortOrder = Integer.valueOf(form.getSortOrder());
102                        var description = form.getDescription();
103
104                        chain = chainControl.createChain(chainType, chainName, chainInstanceSequence, isDefault, sortOrder, partyPK);
105
106                        if(description != null) {
107                            chainControl.createChainDescription(chain, getPreferredLanguage(), description, partyPK);
108                        }
109                    } else {
110                        addExecutionError(ExecutionErrors.UnknownChainInstanceSequenceName.name(), chainInstanceSequenceName);
111                    }
112                } else {
113                    addExecutionError(ExecutionErrors.DuplicateChainName.name(), chainKindName, chainTypeName, chainName);
114                }
115            } else {
116                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
117            }
118        } else {
119            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
120        }
121
122        return null;
123    }
124
125}