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.index.server.command;
018
019import com.echothree.control.user.index.common.edit.IndexEditFactory;
020import com.echothree.control.user.index.common.edit.IndexFieldDescriptionEdit;
021import com.echothree.control.user.index.common.form.EditIndexFieldDescriptionForm;
022import com.echothree.control.user.index.common.result.EditIndexFieldDescriptionResult;
023import com.echothree.control.user.index.common.result.IndexResultFactory;
024import com.echothree.control.user.index.common.spec.IndexFieldDescriptionSpec;
025import com.echothree.model.control.index.server.control.IndexControl;
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.index.server.entity.IndexField;
031import com.echothree.model.data.index.server.entity.IndexFieldDescription;
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 EditIndexFieldDescriptionCommand
047        extends BaseAbstractEditCommand<IndexFieldDescriptionSpec, IndexFieldDescriptionEdit, EditIndexFieldDescriptionResult, IndexFieldDescription, IndexField> {
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.IndexField.name(), SecurityRoles.Description.name())
058                ))
059        ));
060
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("IndexFieldName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064        );
065
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
068        );
069    }
070
071    @Inject
072    IndexControl indexControl;
073
074    @Inject
075    PartyControl partyControl;
076
077    /** Creates a new instance of EditIndexFieldDescriptionCommand */
078    public EditIndexFieldDescriptionCommand() {
079        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
080    }
081
082    @Override
083    public EditIndexFieldDescriptionResult getResult() {
084        return IndexResultFactory.getEditIndexFieldDescriptionResult();
085    }
086
087    @Override
088    public IndexFieldDescriptionEdit getEdit() {
089        return IndexEditFactory.getIndexFieldDescriptionEdit();
090    }
091
092    @Override
093    public IndexFieldDescription getEntity(EditIndexFieldDescriptionResult result) {
094        IndexFieldDescription indexFieldDescription = null;
095        var indexTypeName = spec.getIndexTypeName();
096        var indexType = indexControl.getIndexTypeByName(indexTypeName);
097
098        if(indexType != null) {
099            var indexFieldName = spec.getIndexFieldName();
100            var indexField = indexControl.getIndexFieldByName(indexType, indexFieldName);
101
102            if(indexField != null) {
103                var languageIsoName = spec.getLanguageIsoName();
104                var language = partyControl.getLanguageByIsoName(languageIsoName);
105
106                if(language != null) {
107                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
108                        indexFieldDescription = indexControl.getIndexFieldDescription(indexField, language);
109                    } else { // EditMode.UPDATE
110                        indexFieldDescription = indexControl.getIndexFieldDescriptionForUpdate(indexField, language);
111                    }
112
113                    if(indexFieldDescription == null) {
114                        addExecutionError(ExecutionErrors.UnknownIndexFieldDescription.name(), indexTypeName, indexFieldName, languageIsoName);
115                    }
116                } else {
117                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
118                }
119            } else {
120                addExecutionError(ExecutionErrors.UnknownIndexFieldName.name(), indexTypeName, indexFieldName);
121            }
122        } else {
123            addExecutionError(ExecutionErrors.UnknownIndexTypeName.name(), indexTypeName);
124        }
125
126        return indexFieldDescription;
127    }
128
129    @Override
130    public IndexField getLockEntity(IndexFieldDescription indexFieldDescription) {
131        return indexFieldDescription.getIndexField();
132    }
133
134    @Override
135    public void fillInResult(EditIndexFieldDescriptionResult result, IndexFieldDescription indexFieldDescription) {
136        result.setIndexFieldDescription(indexControl.getIndexFieldDescriptionTransfer(getUserVisit(), indexFieldDescription));
137    }
138
139    @Override
140    public void doLock(IndexFieldDescriptionEdit edit, IndexFieldDescription indexFieldDescription) {
141        edit.setDescription(indexFieldDescription.getDescription());
142    }
143
144    @Override
145    public void doUpdate(IndexFieldDescription indexFieldDescription) {
146        var indexFieldDescriptionValue = indexControl.getIndexFieldDescriptionValue(indexFieldDescription);
147
148        indexFieldDescriptionValue.setDescription(edit.getDescription());
149
150        indexControl.updateIndexFieldDescriptionFromValue(indexFieldDescriptionValue, getPartyPK());
151    }
152
153}