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