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.form.CreateSearchSortOrderDescriptionForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
022import com.echothree.model.control.search.server.control.SearchControl;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class CreateSearchSortOrderDescriptionCommand
042        extends BaseSimpleCommand<CreateSearchSortOrderDescriptionForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.SearchSortOrder.name(), SecurityRoles.Description.name())
052                        )))
053                )));
054
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("SearchSortOrderName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
060                ));
061    }
062    
063    /** Creates a new instance of CreateSearchSortOrderDescriptionCommand */
064    public CreateSearchSortOrderDescriptionCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var searchControl = Session.getModelController(SearchControl.class);
071        var searchKindName = form.getSearchKindName();
072        var searchKind = searchControl.getSearchKindByName(searchKindName);
073        
074        if(searchKind != null) {
075            var searchSortOrderName = form.getSearchSortOrderName();
076            var searchSortOrder = searchControl.getSearchSortOrderByName(searchKind, searchSortOrderName);
077            
078            if(searchSortOrder != null) {
079                var partyControl = Session.getModelController(PartyControl.class);
080                var languageIsoName = form.getLanguageIsoName();
081                var language = partyControl.getLanguageByIsoName(languageIsoName);
082                
083                if(language != null) {
084                    var searchSortOrderDescription = searchControl.getSearchSortOrderDescription(searchSortOrder, language);
085                    
086                    if(searchSortOrderDescription == null) {
087                        var description = form.getDescription();
088                        
089                        searchControl.createSearchSortOrderDescription(searchSortOrder, language, description, getPartyPK());
090                    } else {
091                        addExecutionError(ExecutionErrors.DuplicateSearchSortOrderDescription.name());
092                    }
093                } else {
094                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), searchKindName, searchSortOrderName, languageIsoName);
095                }
096            } else {
097                addExecutionError(ExecutionErrors.UnknownSearchSortOrderName.name(), searchKindName, searchSortOrderName);
098            }
099        } else {
100            addExecutionError(ExecutionErrors.UnknownSearchKindName.name(), searchKindName);
101        }
102        
103        return null;
104    }
105    
106}