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.CreateEntityAppearanceForm;
020import com.echothree.model.control.core.server.logic.AppearanceLogic;
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.core.server.entity.Appearance;
025import com.echothree.model.data.core.server.entity.EntityAppearance;
026import com.echothree.model.data.core.server.entity.EntityInstance;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class CreateEntityAppearanceCommand
041        extends BaseSimpleCommand<CreateEntityAppearanceForm> {
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.EntityAppearance.name(), SecurityRoles.Create.name())
051                        )))
052                )));
053        
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, true, null, null),
056                new FieldDefinition("AppearanceName", FieldType.ENTITY_NAME, true, null, null)
057                ));
058    }
059    
060    /** Creates a new instance of CreateEntityAppearanceCommand */
061    public CreateEntityAppearanceCommand(UserVisitPK userVisitPK, CreateEntityAppearanceForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var coreControl = getCoreControl();
068        String entityRef = form.getEntityRef();
069        EntityInstance entityInstance = coreControl.getEntityInstanceByEntityRef(entityRef);
070
071        if(entityInstance != null) {
072            EntityAppearance entityAppearance = coreControl.getEntityAppearance(entityInstance);
073
074            if(entityAppearance == null) {
075                String appearanceName = form.getAppearanceName();
076                Appearance appearance = AppearanceLogic.getInstance().getAppearanceByName(this, appearanceName);
077
078                if(!hasExecutionErrors()) {
079                    coreControl.createEntityAppearance(entityInstance, appearance, getPartyPK());
080                }
081            } else {
082                addExecutionError(ExecutionErrors.DuplicateEntityAppearance.name(), entityRef);
083            }
084        } else {
085            addExecutionError(ExecutionErrors.UnknownEntityRef.name(), entityRef);
086        }
087
088        return null;
089    }
090    
091}