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.edit.ChainActionSetDescriptionEdit;
020import com.echothree.control.user.chain.common.edit.ChainEditFactory;
021import com.echothree.control.user.chain.common.form.EditChainActionSetDescriptionForm;
022import com.echothree.control.user.chain.common.result.ChainResultFactory;
023import com.echothree.control.user.chain.common.result.EditChainActionSetDescriptionResult;
024import com.echothree.control.user.chain.common.spec.ChainActionSetDescriptionSpec;
025import com.echothree.model.control.chain.server.control.ChainControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.chain.server.entity.ChainActionSet;
031import com.echothree.model.data.chain.server.entity.ChainActionSetDescription;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class EditChainActionSetDescriptionCommand
047        extends BaseAbstractEditCommand<ChainActionSetDescriptionSpec, ChainActionSetDescriptionEdit, EditChainActionSetDescriptionResult, ChainActionSetDescription, ChainActionSet> {
048
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.ChainActionSet.name(), SecurityRoles.Description.name())
058                ))
059        ));
060
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("ChainActionSetName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
067        );
068
069        EDIT_FIELD_DEFINITIONS = List.of(
070                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
071        );
072    }
073
074    @Inject
075    ChainControl chainControl;
076
077    @Inject
078    PartyControl partyControl;
079
080    /** Creates a new instance of EditChainActionSetDescriptionCommand */
081    public EditChainActionSetDescriptionCommand() {
082        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084
085    @Override
086    public EditChainActionSetDescriptionResult getResult() {
087        return ChainResultFactory.getEditChainActionSetDescriptionResult();
088    }
089
090    @Override
091    public ChainActionSetDescriptionEdit getEdit() {
092        return ChainEditFactory.getChainActionSetDescriptionEdit();
093    }
094
095    @Override
096    public ChainActionSetDescription getEntity(EditChainActionSetDescriptionResult result) {
097        ChainActionSetDescription chainActionSetDescription = null;
098        var chainKindName = spec.getChainKindName();
099        var chainKind = chainControl.getChainKindByName(chainKindName);
100
101        if(chainKind != null) {
102            var chainTypeName = spec.getChainTypeName();
103            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
104
105            if(chainType != null) {
106                var chainName = spec.getChainName();
107                var chain = chainControl.getChainByName(chainType, chainName);
108
109                if(chain != null) {
110                    var chainActionSetName = spec.getChainActionSetName();
111                    var chainActionSet = chainControl.getChainActionSetByName(chain, chainActionSetName);
112
113                    if(chainActionSet != null) {
114                        var languageIsoName = spec.getLanguageIsoName();
115                        var language = partyControl.getLanguageByIsoName(languageIsoName);
116
117                        if(language != null) {
118                            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
119                                chainActionSetDescription = chainControl.getChainActionSetDescription(chainActionSet, language);
120                            } else { // EditMode.UPDATE
121                                chainActionSetDescription = chainControl.getChainActionSetDescriptionForUpdate(chainActionSet, language);
122                            }
123
124                            if(chainActionSetDescription == null) {
125                                addExecutionError(ExecutionErrors.UnknownChainActionSetDescription.name(), chainKindName, chainTypeName, chainName, chainActionSetName, languageIsoName);
126                            }
127                        } else {
128                            addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
129                        }
130                    } else {
131                        addExecutionError(ExecutionErrors.UnknownChainActionSetName.name(), chainKindName, chainTypeName, chainName, chainActionSetName);
132                    }
133                } else {
134                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
135                }
136            } else {
137                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
138            }
139        } else {
140            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
141        }
142
143        return chainActionSetDescription;
144    }
145
146    @Override
147    public ChainActionSet getLockEntity(ChainActionSetDescription chainActionSetDescription) {
148        return chainActionSetDescription.getChainActionSet();
149    }
150
151    @Override
152    public void fillInResult(EditChainActionSetDescriptionResult result, ChainActionSetDescription chainActionSetDescription) {
153        result.setChainActionSetDescription(chainControl.getChainActionSetDescriptionTransfer(getUserVisit(), chainActionSetDescription));
154    }
155
156    @Override
157    public void doLock(ChainActionSetDescriptionEdit edit, ChainActionSetDescription chainActionSetDescription) {
158        edit.setDescription(chainActionSetDescription.getDescription());
159    }
160
161    @Override
162    public void doUpdate(ChainActionSetDescription chainActionSetDescription) {
163        var chainActionSetDescriptionValue = chainControl.getChainActionSetDescriptionValue(chainActionSetDescription);
164
165        chainActionSetDescriptionValue.setDescription(edit.getDescription());
166
167        chainControl.updateChainActionSetDescriptionFromValue(chainActionSetDescriptionValue, getPartyPK());
168    }
169
170}