001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.GetEntityAliasForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.EntityAliasControl;
022import com.echothree.model.control.core.server.logic.EntityAliasTypeLogic;
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.EntityAlias;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
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 com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class GetEntityAliasCommand
041        extends BaseSingleEntityCommand<EntityAlias, GetEntityAliasForm> {
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.EntityAlias.name(), SecurityRoles.Review.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
056                new FieldDefinition("Uuid", FieldType.UUID, false, null, null),
057                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, false, null, null),
059                new FieldDefinition("EntityAliasTypeName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
061        );
062    }
063
064    /** Creates a new instance of DeleteEntityAliasCommand */
065    public GetEntityAliasCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068
069    @Override
070    protected EntityAlias getEntity() {
071        var entityAliasType = EntityAliasTypeLogic.getInstance().getEntityAliasTypeByUniversalSpec(this, form);
072        EntityAlias entityAlias = null;
073
074        if(!hasExecutionErrors()) {
075            entityAlias = EntityAliasTypeLogic.getInstance().getEntityAliasByAlias(this, entityAliasType, form.getAlias());
076        }
077
078        return entityAlias;
079    }
080
081    @Override
082    protected BaseResult getResult(EntityAlias entityAlias) {
083        var entityAliasControl = Session.getModelController(EntityAliasControl.class);
084        var result = CoreResultFactory.getGetEntityAliasResult();
085
086        if(entityAlias != null) {
087            result.setEntityAlias(entityAliasControl.getEntityAliasTransfer(getUserVisit(), entityAlias));
088        }
089
090        return result;
091    }
092    
093}