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.CreateSearchKindForm;
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.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;
038
039public class CreateSearchKindCommand
040        extends BaseSimpleCommand<CreateSearchKindForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
049                    new SecurityRoleDefinition(SecurityRoleGroups.SearchKind.name(), SecurityRoles.Create.name())
050                    )))
051                )));
052
053        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
056                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
057                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
058                ));
059    }
060    
061    /** Creates a new instance of CreateSearchKindCommand */
062    public CreateSearchKindCommand(UserVisitPK userVisitPK, CreateSearchKindForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var searchControl = Session.getModelController(SearchControl.class);
069        String searchKindName = form.getSearchKindName();
070        SearchKind searchKind = searchControl.getSearchKindByName(searchKindName);
071        
072        if(searchKind == null) {
073            var partyPK = getPartyPK();
074            var isDefault = Boolean.valueOf(form.getIsDefault());
075            var sortOrder = Integer.valueOf(form.getSortOrder());
076            var description = form.getDescription();
077
078            searchKind = searchControl.createSearchKind(searchKindName, isDefault, sortOrder, partyPK);
079
080            if(description != null) {
081                searchControl.createSearchKindDescription(searchKind, getPreferredLanguage(), description, partyPK);
082            }
083        } else {
084            addExecutionError(ExecutionErrors.DuplicateSearchKindName.name(), searchKindName);
085        }
086        
087        return null;
088    }
089    
090}