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.core.server.command;
018
019import com.echothree.control.user.core.common.form.CreateEntityNameAttributeForm;
020import com.echothree.model.control.core.common.EntityAttributeTypes;
021import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
022import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.control.CommandSecurityDefinition;
030import com.echothree.util.server.control.PartyTypeDefinition;
031import java.util.Arrays;
032import java.util.Collections;
033import java.util.List;
034
035public class CreateEntityNameAttributeCommand
036        extends BaseSimpleCommand<CreateEntityNameAttributeForm> {
037
038    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
043                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
044                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
045        ));
046
047        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
048                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
049                new FieldDefinition("Key", FieldType.KEY, false, null, null),
050                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
051                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
052                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
053                new FieldDefinition("EntityAttributeUlid", FieldType.ULID, false, null, null),
054                new FieldDefinition("NameAttribute", FieldType.ENTITY_NAME, true, null, null)
055                ));
056    }
057    
058    /** Creates a new instance of CreateEntityNameAttributeCommand */
059    public CreateEntityNameAttributeCommand(UserVisitPK userVisitPK, CreateEntityNameAttributeForm form) {
060        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
061    }
062    
063    @Override
064    protected BaseResult execute() {
065        var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form);
066
067        if(!hasExecutionErrors()) {
068            var entityAttribute = EntityAttributeLogic.getInstance().getEntityAttribute(this, entityInstance, form, form,
069                    EntityAttributeTypes.NAME);
070
071            if(!hasExecutionErrors()) {
072                EntityAttributeLogic.getInstance().createEntityNameAttribute(this, entityAttribute, form.getNameAttribute(), entityInstance,
073                        getPartyPK());
074            }
075        }
076
077        return null;
078    }
079    
080}