001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.control.AppearanceControl;
021import com.echothree.model.control.core.server.control.EntityInstanceControl;
022import com.echothree.model.control.core.server.logic.AppearanceLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
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.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 java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
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(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAppearance.name(), SecurityRoles.Create.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, true, null, null),
056                new FieldDefinition("AppearanceName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059
060    @Inject
061    AppearanceControl appearanceControl;
062
063    @Inject
064    EntityInstanceControl entityInstanceControl;
065
066    @Inject
067    AppearanceLogic appearanceLogic;
068
069    
070    /** Creates a new instance of CreateEntityAppearanceCommand */
071    public CreateEntityAppearanceCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
073    }
074    
075    @Override
076    protected BaseResult execute() {
077        var entityRef = form.getEntityRef();
078        var entityInstance = entityInstanceControl.getEntityInstanceByEntityRef(entityRef);
079
080        if(entityInstance != null) {
081            var entityAppearance = appearanceControl.getEntityAppearance(entityInstance);
082
083            if(entityAppearance == null) {
084                var appearanceName = form.getAppearanceName();
085                var appearance = appearanceLogic.getAppearanceByName(this, appearanceName);
086
087                if(!hasExecutionErrors()) {
088                    appearanceControl.createEntityAppearance(entityInstance, appearance, getPartyPK());
089                }
090            } else {
091                addExecutionError(ExecutionErrors.DuplicateEntityAppearance.name(), entityRef);
092            }
093        } else {
094            addExecutionError(ExecutionErrors.UnknownEntityRef.name(), entityRef);
095        }
096
097        return null;
098    }
099    
100}