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.GetEntityAppearanceForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.AppearanceControl;
022import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
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.core.server.entity.EntityAppearance;
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.BaseSingleEntityCommand;
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 GetEntityAppearanceCommand
041        extends BaseSingleEntityCommand<EntityAppearance, GetEntityAppearanceForm> {
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.Review.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, true, null, null)
056        );
057    }
058
059    @Inject
060    AppearanceControl appearanceControl;
061
062    @Inject
063    EntityInstanceLogic entityInstanceLogic;
064
065    
066    /** Creates a new instance of GetEntityAppearanceCommand */
067    public GetEntityAppearanceCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected EntityAppearance getEntity() {
073        var entityRef = form.getEntityRef();
074        var entityInstance = entityInstanceLogic.getEntityInstanceByEntityRef(this, entityRef);
075        EntityAppearance entityAppearance = null;
076
077        if(!hasExecutionErrors()) {
078            entityAppearance = appearanceControl.getEntityAppearance(entityInstance);
079
080            if(entityAppearance == null) {
081                addExecutionError(ExecutionErrors.UnknownEntityAppearance.name(), entityRef);
082            }
083        }
084
085        return entityAppearance;
086    }
087
088    @Override
089    protected BaseResult getResult(EntityAppearance entityAppearance) {
090        var result = CoreResultFactory.getGetEntityAppearanceResult();
091
092        if(entityAppearance != null) {
093            result.setEntityAppearance(appearanceControl.getEntityAppearanceTransfer(getUserVisit(), entityAppearance));
094        }
095
096        return result;
097    }
098    
099}