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.GetSearchSortOrderDescriptionsForm;
020import com.echothree.control.user.search.common.result.GetSearchSortOrderDescriptionsResult;
021import com.echothree.control.user.search.common.result.SearchResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.search.server.control.SearchControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.search.server.entity.SearchKind;
027import com.echothree.model.data.search.server.entity.SearchSortOrder;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class GetSearchSortOrderDescriptionsCommand
043        extends BaseSimpleCommand<GetSearchSortOrderDescriptionsForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.SearchSortOrder.name(), SecurityRoles.Description.name())
053                        )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("SearchSortOrderName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetSearchSortOrderDescriptionsCommand */
063    public GetSearchSortOrderDescriptionsCommand(UserVisitPK userVisitPK, GetSearchSortOrderDescriptionsForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var searchControl = Session.getModelController(SearchControl.class);
070        GetSearchSortOrderDescriptionsResult result = SearchResultFactory.getGetSearchSortOrderDescriptionsResult();
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                result.setSearchSortOrder(searchControl.getSearchSortOrderTransfer(getUserVisit(), searchSortOrder));
080                result.setSearchSortOrderDescriptions(searchControl.getSearchSortOrderDescriptionTransfersBySearchSortOrder(getUserVisit(), searchSortOrder));
081            } else {
082                addExecutionError(ExecutionErrors.UnknownSearchSortOrderName.name(), searchKindName, searchSortOrderName);
083            }
084        } else {
085            addExecutionError(ExecutionErrors.UnknownSearchKindName.name(), searchKindName);
086        }
087        
088        return result;
089    }
090    
091}