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.search.server.command;
018
019import com.echothree.control.user.search.common.edit.SearchEditFactory;
020import com.echothree.control.user.search.common.edit.SearchKindDescriptionEdit;
021import com.echothree.control.user.search.common.form.EditSearchKindDescriptionForm;
022import com.echothree.control.user.search.common.result.EditSearchKindDescriptionResult;
023import com.echothree.control.user.search.common.result.SearchResultFactory;
024import com.echothree.control.user.search.common.spec.SearchKindDescriptionSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.search.server.control.SearchControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.search.server.entity.SearchKind;
031import com.echothree.model.data.search.server.entity.SearchKindDescription;
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 EditSearchKindDescriptionCommand
047        extends BaseAbstractEditCommand<SearchKindDescriptionSpec, SearchKindDescriptionEdit, EditSearchKindDescriptionResult, SearchKindDescription, SearchKind> {
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.SearchKind.name(), SecurityRoles.Description.name())
058                ))
059        ));
060
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("SearchKindName", 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    PartyControl partyControl;
073
074    @Inject
075    SearchControl searchControl;
076
077    /** Creates a new instance of EditSearchKindDescriptionCommand */
078    public EditSearchKindDescriptionCommand() {
079        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
080    }
081
082    @Override
083    public EditSearchKindDescriptionResult getResult() {
084        return SearchResultFactory.getEditSearchKindDescriptionResult();
085    }
086
087    @Override
088    public SearchKindDescriptionEdit getEdit() {
089        return SearchEditFactory.getSearchKindDescriptionEdit();
090    }
091
092    @Override
093    public SearchKindDescription getEntity(EditSearchKindDescriptionResult result) {
094        SearchKindDescription searchKindDescription = null;
095        var searchKindName = spec.getSearchKindName();
096        var searchKind = searchControl.getSearchKindByName(searchKindName);
097
098        if(searchKind != null) {
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                    searchKindDescription = searchControl.getSearchKindDescription(searchKind, language);
105                } else { // EditMode.UPDATE
106                    searchKindDescription = searchControl.getSearchKindDescriptionForUpdate(searchKind, language);
107                }
108
109                if(searchKindDescription == null) {
110                    addExecutionError(ExecutionErrors.UnknownSearchKindDescription.name(), searchKindName, languageIsoName);
111                }
112            } else {
113                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
114            }
115        } else {
116            addExecutionError(ExecutionErrors.UnknownSearchKindName.name(), searchKindName);
117        }
118
119        return searchKindDescription;
120    }
121
122    @Override
123    public SearchKind getLockEntity(SearchKindDescription searchKindDescription) {
124        return searchKindDescription.getSearchKind();
125    }
126
127    @Override
128    public void fillInResult(EditSearchKindDescriptionResult result, SearchKindDescription searchKindDescription) {
129        result.setSearchKindDescription(searchControl.getSearchKindDescriptionTransfer(getUserVisit(), searchKindDescription));
130    }
131
132    @Override
133    public void doLock(SearchKindDescriptionEdit edit, SearchKindDescription searchKindDescription) {
134        edit.setDescription(searchKindDescription.getDescription());
135    }
136
137    @Override
138    public void doUpdate(SearchKindDescription searchKindDescription) {
139        var searchKindDescriptionValue = searchControl.getSearchKindDescriptionValue(searchKindDescription);
140
141        searchKindDescriptionValue.setDescription(edit.getDescription());
142
143        searchControl.updateSearchKindDescriptionFromValue(searchKindDescriptionValue, getPartyPK());
144    }
145
146}