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.ChainDescriptionEdit;
020import com.echothree.control.user.chain.common.edit.ChainEditFactory;
021import com.echothree.control.user.chain.common.form.EditChainDescriptionForm;
022import com.echothree.control.user.chain.common.result.ChainResultFactory;
023import com.echothree.control.user.chain.common.result.EditChainDescriptionResult;
024import com.echothree.control.user.chain.common.spec.ChainDescriptionSpec;
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.Chain;
031import com.echothree.model.data.chain.server.entity.ChainDescription;
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 com.echothree.util.server.persistence.Session;
042import java.util.List;
043import javax.enterprise.context.Dependent;
044
045@Dependent
046public class EditChainDescriptionCommand
047        extends BaseAbstractEditCommand<ChainDescriptionSpec, ChainDescriptionEdit, EditChainDescriptionResult, ChainDescription, Chain> {
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.Chain.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("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
066                );
067
068        EDIT_FIELD_DEFINITIONS = List.of(
069                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
070                );
071    }
072
073    /** Creates a new instance of EditChainDescriptionCommand */
074    public EditChainDescriptionCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077
078    @Override
079    public EditChainDescriptionResult getResult() {
080        return ChainResultFactory.getEditChainDescriptionResult();
081    }
082
083    @Override
084    public ChainDescriptionEdit getEdit() {
085        return ChainEditFactory.getChainDescriptionEdit();
086    }
087
088    @Override
089    public ChainDescription getEntity(EditChainDescriptionResult result) {
090        var chainControl = Session.getModelController(ChainControl.class);
091        ChainDescription chainDescription = null;
092        var chainKindName = spec.getChainKindName();
093        var chainKind = chainControl.getChainKindByName(chainKindName);
094
095        if(chainKind != null) {
096            var chainTypeName = spec.getChainTypeName();
097            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
098
099            if(chainType != null) {
100                var chainName = spec.getChainName();
101                var chain = chainControl.getChainByName(chainType, chainName);
102
103                if(chain != null) {
104                    var partyControl = Session.getModelController(PartyControl.class);
105                    var languageIsoName = spec.getLanguageIsoName();
106                    var language = partyControl.getLanguageByIsoName(languageIsoName);
107
108                    if(language != null) {
109                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
110                            chainDescription = chainControl.getChainDescription(chain, language);
111                        } else { // EditMode.UPDATE
112                            chainDescription = chainControl.getChainDescriptionForUpdate(chain, language);
113                        }
114
115                        if(chainDescription == null) {
116                            addExecutionError(ExecutionErrors.UnknownChainDescription.name(), chainKindName, chainTypeName, chainName, languageIsoName);
117                        }
118                    } else {
119                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
120                    }
121                } else {
122                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
123                }
124            } else {
125                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
126            }
127        } else {
128            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
129        }
130
131        return chainDescription;
132    }
133
134    @Override
135    public Chain getLockEntity(ChainDescription chainDescription) {
136        return chainDescription.getChain();
137    }
138
139    @Override
140    public void fillInResult(EditChainDescriptionResult result, ChainDescription chainDescription) {
141        var chainControl = Session.getModelController(ChainControl.class);
142
143        result.setChainDescription(chainControl.getChainDescriptionTransfer(getUserVisit(), chainDescription));
144    }
145
146    @Override
147    public void doLock(ChainDescriptionEdit edit, ChainDescription chainDescription) {
148        edit.setDescription(chainDescription.getDescription());
149    }
150
151    @Override
152    public void doUpdate(ChainDescription chainDescription) {
153        var chainControl = Session.getModelController(ChainControl.class);
154        var chainDescriptionValue = chainControl.getChainDescriptionValue(chainDescription);
155
156        chainDescriptionValue.setDescription(edit.getDescription());
157
158        chainControl.updateChainDescriptionFromValue(chainDescriptionValue, getPartyPK());
159    }
160
161}