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