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.index.server.command;
018
019import com.echothree.control.user.index.common.form.DeleteIndexFieldForm;
020import com.echothree.model.control.index.server.control.IndexControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.index.server.entity.IndexField;
025import com.echothree.model.data.index.server.entity.IndexType;
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 DeleteIndexFieldCommand
041        extends BaseSimpleCommand<DeleteIndexFieldForm> {
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.IndexField.name(), SecurityRoles.Delete.name())
051                    )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("IndexTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("IndexFieldName", FieldType.ENTITY_NAME, true, null, null)
057                ));
058    }
059    
060    /** Creates a new instance of DeleteIndexFieldCommand */
061    public DeleteIndexFieldCommand(UserVisitPK userVisitPK, DeleteIndexFieldForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var indexControl = Session.getModelController(IndexControl.class);
068        String indexTypeName = form.getIndexTypeName();
069        IndexType indexType = indexControl.getIndexTypeByName(indexTypeName);
070        
071        if(indexType != null) {
072            String indexFieldName = form.getIndexFieldName();
073            IndexField indexField = indexControl.getIndexFieldByNameForUpdate(indexType, indexFieldName);
074            
075            if(indexField != null) {
076                indexControl.deleteIndexField(indexField, getPartyPK());
077            } else {
078                addExecutionError(ExecutionErrors.UnknownIndexFieldName.name(), indexTypeName, indexFieldName);
079            }
080        } else {
081            addExecutionError(ExecutionErrors.DuplicateIndexTypeName.name(), indexTypeName);
082        }
083        
084        return null;
085    }
086    
087}