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.ChainActionDescriptionEdit;
020import com.echothree.control.user.chain.common.edit.ChainEditFactory;
021import com.echothree.control.user.chain.common.form.EditChainActionDescriptionForm;
022import com.echothree.control.user.chain.common.result.ChainResultFactory;
023import com.echothree.control.user.chain.common.result.EditChainActionDescriptionResult;
024import com.echothree.control.user.chain.common.spec.ChainActionDescriptionSpec;
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.ChainAction;
031import com.echothree.model.data.chain.server.entity.ChainActionDescription;
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 EditChainActionDescriptionCommand
047        extends BaseAbstractEditCommand<ChainActionDescriptionSpec, ChainActionDescriptionEdit, EditChainActionDescriptionResult, ChainActionDescription, ChainAction> {
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.ChainAction.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("ChainActionName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
068        );
069
070        EDIT_FIELD_DEFINITIONS = List.of(
071                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
072        );
073    }
074
075    @Inject
076    ChainControl chainControl;
077
078    @Inject
079    PartyControl partyControl;
080
081    /** Creates a new instance of EditChainActionDescriptionCommand */
082    public EditChainActionDescriptionCommand() {
083        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
084    }
085
086    @Override
087    public EditChainActionDescriptionResult getResult() {
088        return ChainResultFactory.getEditChainActionDescriptionResult();
089    }
090
091    @Override
092    public ChainActionDescriptionEdit getEdit() {
093        return ChainEditFactory.getChainActionDescriptionEdit();
094    }
095
096    @Override
097    public ChainActionDescription getEntity(EditChainActionDescriptionResult result) {
098        ChainActionDescription chainActionDescription = null;
099        var chainKindName = spec.getChainKindName();
100        var chainKind = chainControl.getChainKindByName(chainKindName);
101
102        if(chainKind != null) {
103            var chainTypeName = spec.getChainTypeName();
104            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
105
106            if(chainType != null) {
107                var chainName = spec.getChainName();
108                var chain = chainControl.getChainByName(chainType, chainName);
109
110                if(chain != null) {
111                    var chainActionSetName = spec.getChainActionSetName();
112                    var chainActionSet = chainControl.getChainActionSetByName(chain, chainActionSetName);
113
114                    if(chainActionSet != null) {
115                        var chainActionName = spec.getChainActionName();
116                        var chainAction = chainControl.getChainActionByName(chainActionSet, chainActionName);
117
118                        if(chainAction != null) {
119                            var languageIsoName = spec.getLanguageIsoName();
120                            var language = partyControl.getLanguageByIsoName(languageIsoName);
121
122                            if(language != null) {
123                                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
124                                    chainActionDescription = chainControl.getChainActionDescription(chainAction, language);
125                                } else { // EditMode.UPDATE
126                                    chainActionDescription = chainControl.getChainActionDescriptionForUpdate(chainAction, language);
127                                }
128
129                                if(chainActionDescription == null) {
130                                    addExecutionError(ExecutionErrors.UnknownChainActionDescription.name(), chainKindName, chainTypeName, chainName,
131                                            chainActionSetName, chainActionName, languageIsoName);
132                                }
133                            } else {
134                                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
135                            }
136                        } else {
137                            addExecutionError(ExecutionErrors.UnknownChainActionName.name(), chainKindName, chainTypeName, chainName, chainActionSetName,
138                                    chainActionName);
139                        }
140                    } else {
141                        addExecutionError(ExecutionErrors.UnknownChainActionSetName.name(), chainKindName, chainTypeName, chainName, chainActionSetName);
142                    }
143                } else {
144                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
145                }
146            } else {
147                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
148            }
149        } else {
150            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
151        }
152
153        return chainActionDescription;
154    }
155
156    @Override
157    public ChainAction getLockEntity(ChainActionDescription chainActionDescription) {
158        return chainActionDescription.getChainAction();
159    }
160
161    @Override
162    public void fillInResult(EditChainActionDescriptionResult result, ChainActionDescription chainActionDescription) {
163        result.setChainActionDescription(chainControl.getChainActionDescriptionTransfer(getUserVisit(), chainActionDescription));
164    }
165
166    @Override
167    public void doLock(ChainActionDescriptionEdit edit, ChainActionDescription chainActionDescription) {
168        edit.setDescription(chainActionDescription.getDescription());
169    }
170
171    @Override
172    public void doUpdate(ChainActionDescription chainActionDescription) {
173        var chainActionDescriptionValue = chainControl.getChainActionDescriptionValue(chainActionDescription);
174
175        chainActionDescriptionValue.setDescription(edit.getDescription());
176
177        chainControl.updateChainActionDescriptionFromValue(chainActionDescriptionValue, getPartyPK());
178    }
179
180}