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 com.echothree.util.server.persistence.Session;
042import java.util.List;
043import javax.enterprise.context.Dependent;
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    /** Creates a new instance of EditIndexFieldDescriptionCommand */
072    public EditIndexFieldDescriptionCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075
076    @Override
077    public EditIndexFieldDescriptionResult getResult() {
078        return IndexResultFactory.getEditIndexFieldDescriptionResult();
079    }
080
081    @Override
082    public IndexFieldDescriptionEdit getEdit() {
083        return IndexEditFactory.getIndexFieldDescriptionEdit();
084    }
085
086    @Override
087    public IndexFieldDescription getEntity(EditIndexFieldDescriptionResult result) {
088        var indexControl = Session.getModelController(IndexControl.class);
089        IndexFieldDescription indexFieldDescription = null;
090        var indexTypeName = spec.getIndexTypeName();
091        var indexType = indexControl.getIndexTypeByName(indexTypeName);
092
093        if(indexType != null) {
094            var indexFieldName = spec.getIndexFieldName();
095            var indexField = indexControl.getIndexFieldByName(indexType, indexFieldName);
096
097            if(indexField != null) {
098                var partyControl = Session.getModelController(PartyControl.class);
099                var languageIsoName = spec.getLanguageIsoName();
100                var language = partyControl.getLanguageByIsoName(languageIsoName);
101
102                if(language != null) {
103                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
104                        indexFieldDescription = indexControl.getIndexFieldDescription(indexField, language);
105                    } else { // EditMode.UPDATE
106                        indexFieldDescription = indexControl.getIndexFieldDescriptionForUpdate(indexField, language);
107                    }
108
109                    if(indexFieldDescription == null) {
110                        addExecutionError(ExecutionErrors.UnknownIndexFieldDescription.name(), indexTypeName, indexFieldName, languageIsoName);
111                    }
112                } else {
113                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
114                }
115            } else {
116                addExecutionError(ExecutionErrors.UnknownIndexFieldName.name(), indexTypeName, indexFieldName);
117            }
118        } else {
119            addExecutionError(ExecutionErrors.UnknownIndexTypeName.name(), indexTypeName);
120        }
121
122        return indexFieldDescription;
123    }
124
125    @Override
126    public IndexField getLockEntity(IndexFieldDescription indexFieldDescription) {
127        return indexFieldDescription.getIndexField();
128    }
129
130    @Override
131    public void fillInResult(EditIndexFieldDescriptionResult result, IndexFieldDescription indexFieldDescription) {
132        var indexControl = Session.getModelController(IndexControl.class);
133
134        result.setIndexFieldDescription(indexControl.getIndexFieldDescriptionTransfer(getUserVisit(), indexFieldDescription));
135    }
136
137    @Override
138    public void doLock(IndexFieldDescriptionEdit edit, IndexFieldDescription indexFieldDescription) {
139        edit.setDescription(indexFieldDescription.getDescription());
140    }
141
142    @Override
143    public void doUpdate(IndexFieldDescription indexFieldDescription) {
144        var indexControl = Session.getModelController(IndexControl.class);
145        var indexFieldDescriptionValue = indexControl.getIndexFieldDescriptionValue(indexFieldDescription);
146
147        indexFieldDescriptionValue.setDescription(edit.getDescription());
148
149        indexControl.updateIndexFieldDescriptionFromValue(indexFieldDescriptionValue, getPartyPK());
150    }
151
152}