001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.CreateSearchSortOrderForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.search.server.control.SearchControl;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.search.server.entity.SearchKind;
025import com.echothree.model.data.search.server.entity.SearchSortOrder;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class CreateSearchSortOrderCommand
041        extends BaseSimpleCommand<CreateSearchSortOrderForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                    new SecurityRoleDefinition(SecurityRoleGroups.SearchSortOrder.name(), SecurityRoles.Create.name())
051                    )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("SearchSortOrderName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
058                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
059                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
060                ));
061    }
062    
063    /** Creates a new instance of CreateSearchSortOrderCommand */
064    public CreateSearchSortOrderCommand(UserVisitPK userVisitPK, CreateSearchSortOrderForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var searchControl = Session.getModelController(SearchControl.class);
071        String searchKindName = form.getSearchKindName();
072        SearchKind searchKind = searchControl.getSearchKindByName(searchKindName);
073        
074        if(searchKind != null) {
075            String searchSortOrderName = form.getSearchSortOrderName();
076            SearchSortOrder searchSortOrder = searchControl.getSearchSortOrderByName(searchKind, searchSortOrderName);
077            
078            if(searchSortOrder == null) {
079                var partyPK = getPartyPK();
080                var isDefault = Boolean.valueOf(form.getIsDefault());
081                var sortOrder = Integer.valueOf(form.getSortOrder());
082                var description = form.getDescription();
083
084                searchSortOrder = searchControl.createSearchSortOrder(searchKind, searchSortOrderName, isDefault, sortOrder, partyPK);
085
086                if(description != null) {
087                    searchControl.createSearchSortOrderDescription(searchSortOrder, getPreferredLanguage(), description, partyPK);
088                }
089            } else {
090                addExecutionError(ExecutionErrors.DuplicateSearchSortOrderName.name(), searchKindName, searchSortOrderName);
091            }
092        } else {
093            addExecutionError(ExecutionErrors.DuplicateSearchKindName.name(), searchKindName);
094        }
095        
096        return null;
097    }
098    
099}