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.SearchKindEdit;
021import com.echothree.control.user.search.common.form.EditSearchKindForm;
022import com.echothree.control.user.search.common.result.EditSearchKindResult;
023import com.echothree.control.user.search.common.result.SearchResultFactory;
024import com.echothree.control.user.search.common.spec.SearchKindSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.search.server.control.SearchControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.search.server.entity.SearchKind;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042
043@Dependent
044public class EditSearchKindCommand
045        extends BaseAbstractEditCommand<SearchKindSpec, SearchKindEdit, EditSearchKindResult, SearchKind, SearchKind> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.SearchKind.name(), SecurityRoles.Edit.name())
056                        ))
057                ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, true, null, null)
061                );
062
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068                );
069    }
070
071    /** Creates a new instance of EditSearchKindCommand */
072    public EditSearchKindCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075
076    @Override
077    public EditSearchKindResult getResult() {
078        return SearchResultFactory.getEditSearchKindResult();
079    }
080
081    @Override
082    public SearchKindEdit getEdit() {
083        return SearchEditFactory.getSearchKindEdit();
084    }
085
086    @Override
087    public SearchKind getEntity(EditSearchKindResult result) {
088        var searchControl = Session.getModelController(SearchControl.class);
089        SearchKind searchKind;
090        var searchKindName = spec.getSearchKindName();
091
092        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093            searchKind = searchControl.getSearchKindByName(searchKindName);
094        } else { // EditMode.UPDATE
095            searchKind = searchControl.getSearchKindByNameForUpdate(searchKindName);
096        }
097
098        if(searchKind == null) {
099            addExecutionError(ExecutionErrors.UnknownSearchKindName.name(), searchKindName);
100        }
101
102        return searchKind;
103    }
104
105    @Override
106    public SearchKind getLockEntity(SearchKind searchKind) {
107        return searchKind;
108    }
109
110    @Override
111    public void fillInResult(EditSearchKindResult result, SearchKind searchKind) {
112        var searchControl = Session.getModelController(SearchControl.class);
113
114        result.setSearchKind(searchControl.getSearchKindTransfer(getUserVisit(), searchKind));
115    }
116
117    @Override
118    public void doLock(SearchKindEdit edit, SearchKind searchKind) {
119        var searchControl = Session.getModelController(SearchControl.class);
120        var searchKindDescription = searchControl.getSearchKindDescription(searchKind, getPreferredLanguage());
121        var searchKindDetail = searchKind.getLastDetail();
122
123        edit.setSearchKindName(searchKindDetail.getSearchKindName());
124        edit.setIsDefault(searchKindDetail.getIsDefault().toString());
125        edit.setSortOrder(searchKindDetail.getSortOrder().toString());
126
127        if(searchKindDescription != null) {
128            edit.setDescription(searchKindDescription.getDescription());
129        }
130    }
131
132    @Override
133    public void canUpdate(SearchKind searchKind) {
134        var searchControl = Session.getModelController(SearchControl.class);
135        var searchKindName = edit.getSearchKindName();
136        var duplicateSearchKind = searchControl.getSearchKindByName(searchKindName);
137
138        if(duplicateSearchKind != null && !searchKind.equals(duplicateSearchKind)) {
139            addExecutionError(ExecutionErrors.DuplicateSearchKindName.name(), searchKindName);
140        }
141    }
142
143    @Override
144    public void doUpdate(SearchKind searchKind) {
145        var searchControl = Session.getModelController(SearchControl.class);
146        var partyPK = getPartyPK();
147        var searchKindDetailValue = searchControl.getSearchKindDetailValueForUpdate(searchKind);
148        var searchKindDescription = searchControl.getSearchKindDescriptionForUpdate(searchKind, getPreferredLanguage());
149        var description = edit.getDescription();
150
151        searchKindDetailValue.setSearchKindName(edit.getSearchKindName());
152        searchKindDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
153        searchKindDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
154
155        searchControl.updateSearchKindFromValue(searchKindDetailValue, partyPK);
156
157        if(searchKindDescription == null && description != null) {
158            searchControl.createSearchKindDescription(searchKind, getPreferredLanguage(), description, partyPK);
159        } else if(searchKindDescription != null && description == null) {
160            searchControl.deleteSearchKindDescription(searchKindDescription, partyPK);
161        } else if(searchKindDescription != null && description != null) {
162            var searchKindDescriptionValue = searchControl.getSearchKindDescriptionValue(searchKindDescription);
163
164            searchKindDescriptionValue.setDescription(description);
165            searchControl.updateSearchKindDescriptionFromValue(searchKindDescriptionValue, partyPK);
166        }
167    }
168
169}