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.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.Arrays;
043import java.util.Collections;
044import java.util.List;
045import javax.enterprise.context.RequestScoped;
046
047@RequestScoped
048public class EditIndexFieldDescriptionCommand
049        extends BaseAbstractEditCommand<IndexFieldDescriptionSpec, IndexFieldDescriptionEdit, EditIndexFieldDescriptionResult, IndexFieldDescription, IndexField> {
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.IndexField.name(), SecurityRoles.Description.name())
060                        )))
061                )));
062
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("IndexFieldName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
066                ));
067
068        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
069                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
070                ));
071    }
072
073    /** Creates a new instance of EditIndexFieldDescriptionCommand */
074    public EditIndexFieldDescriptionCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077
078    @Override
079    public EditIndexFieldDescriptionResult getResult() {
080        return IndexResultFactory.getEditIndexFieldDescriptionResult();
081    }
082
083    @Override
084    public IndexFieldDescriptionEdit getEdit() {
085        return IndexEditFactory.getIndexFieldDescriptionEdit();
086    }
087
088    @Override
089    public IndexFieldDescription getEntity(EditIndexFieldDescriptionResult result) {
090        var indexControl = Session.getModelController(IndexControl.class);
091        IndexFieldDescription indexFieldDescription = null;
092        var indexTypeName = spec.getIndexTypeName();
093        var indexType = indexControl.getIndexTypeByName(indexTypeName);
094
095        if(indexType != null) {
096            var indexFieldName = spec.getIndexFieldName();
097            var indexField = indexControl.getIndexFieldByName(indexType, indexFieldName);
098
099            if(indexField != null) {
100                var partyControl = Session.getModelController(PartyControl.class);
101                var languageIsoName = spec.getLanguageIsoName();
102                var language = partyControl.getLanguageByIsoName(languageIsoName);
103
104                if(language != null) {
105                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
106                        indexFieldDescription = indexControl.getIndexFieldDescription(indexField, language);
107                    } else { // EditMode.UPDATE
108                        indexFieldDescription = indexControl.getIndexFieldDescriptionForUpdate(indexField, language);
109                    }
110
111                    if(indexFieldDescription == null) {
112                        addExecutionError(ExecutionErrors.UnknownIndexFieldDescription.name(), indexTypeName, indexFieldName, languageIsoName);
113                    }
114                } else {
115                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
116                }
117            } else {
118                addExecutionError(ExecutionErrors.UnknownIndexFieldName.name(), indexTypeName, indexFieldName);
119            }
120        } else {
121            addExecutionError(ExecutionErrors.UnknownIndexTypeName.name(), indexTypeName);
122        }
123
124        return indexFieldDescription;
125    }
126
127    @Override
128    public IndexField getLockEntity(IndexFieldDescription indexFieldDescription) {
129        return indexFieldDescription.getIndexField();
130    }
131
132    @Override
133    public void fillInResult(EditIndexFieldDescriptionResult result, IndexFieldDescription indexFieldDescription) {
134        var indexControl = Session.getModelController(IndexControl.class);
135
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 indexControl = Session.getModelController(IndexControl.class);
147        var indexFieldDescriptionValue = indexControl.getIndexFieldDescriptionValue(indexFieldDescription);
148
149        indexFieldDescriptionValue.setDescription(edit.getDescription());
150
151        indexControl.updateIndexFieldDescriptionFromValue(indexFieldDescriptionValue, getPartyPK());
152    }
153
154}