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.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.Arrays;
043import java.util.Collections;
044import java.util.List;
045import javax.enterprise.context.RequestScoped;
046
047@RequestScoped
048public class EditChainDescriptionCommand
049        extends BaseAbstractEditCommand<ChainDescriptionSpec, ChainDescriptionEdit, EditChainDescriptionResult, ChainDescription, Chain> {
050
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
059                        new SecurityRoleDefinition(SecurityRoleGroups.Chain.name(), SecurityRoles.Description.name())
060                        )))
061                )));
062
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
068                ));
069
070        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
071                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
072                ));
073    }
074
075    /** Creates a new instance of EditChainDescriptionCommand */
076    public EditChainDescriptionCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079
080    @Override
081    public EditChainDescriptionResult getResult() {
082        return ChainResultFactory.getEditChainDescriptionResult();
083    }
084
085    @Override
086    public ChainDescriptionEdit getEdit() {
087        return ChainEditFactory.getChainDescriptionEdit();
088    }
089
090    @Override
091    public ChainDescription getEntity(EditChainDescriptionResult result) {
092        var chainControl = Session.getModelController(ChainControl.class);
093        ChainDescription chainDescription = null;
094        var chainKindName = spec.getChainKindName();
095        var chainKind = chainControl.getChainKindByName(chainKindName);
096
097        if(chainKind != null) {
098            var chainTypeName = spec.getChainTypeName();
099            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
100
101            if(chainType != null) {
102                var chainName = spec.getChainName();
103                var chain = chainControl.getChainByName(chainType, chainName);
104
105                if(chain != null) {
106                    var partyControl = Session.getModelController(PartyControl.class);
107                    var languageIsoName = spec.getLanguageIsoName();
108                    var language = partyControl.getLanguageByIsoName(languageIsoName);
109
110                    if(language != null) {
111                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
112                            chainDescription = chainControl.getChainDescription(chain, language);
113                        } else { // EditMode.UPDATE
114                            chainDescription = chainControl.getChainDescriptionForUpdate(chain, language);
115                        }
116
117                        if(chainDescription == null) {
118                            addExecutionError(ExecutionErrors.UnknownChainDescription.name(), chainKindName, chainTypeName, chainName, languageIsoName);
119                        }
120                    } else {
121                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
122                    }
123                } else {
124                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
125                }
126            } else {
127                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
128            }
129        } else {
130            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
131        }
132
133        return chainDescription;
134    }
135
136    @Override
137    public Chain getLockEntity(ChainDescription chainDescription) {
138        return chainDescription.getChain();
139    }
140
141    @Override
142    public void fillInResult(EditChainDescriptionResult result, ChainDescription chainDescription) {
143        var chainControl = Session.getModelController(ChainControl.class);
144
145        result.setChainDescription(chainControl.getChainDescriptionTransfer(getUserVisit(), chainDescription));
146    }
147
148    @Override
149    public void doLock(ChainDescriptionEdit edit, ChainDescription chainDescription) {
150        edit.setDescription(chainDescription.getDescription());
151    }
152
153    @Override
154    public void doUpdate(ChainDescription chainDescription) {
155        var chainControl = Session.getModelController(ChainControl.class);
156        var chainDescriptionValue = chainControl.getChainDescriptionValue(chainDescription);
157
158        chainDescriptionValue.setDescription(edit.getDescription());
159
160        chainControl.updateChainDescriptionFromValue(chainDescriptionValue, getPartyPK());
161    }
162
163}