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.GetEntityAliasForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.logic.EntityAliasTypeLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.core.server.entity.EntityAlias;
026import com.echothree.model.data.core.server.entity.EntityAliasType;
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 java.util.List;
036
037public class GetEntityAliasCommand
038        extends BaseSingleEntityCommand<EntityAlias, GetEntityAliasForm> {
039
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
045                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
047                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAlias.name(), SecurityRoles.Review.name())
048                ))
049        ));
050
051        FORM_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
053                new FieldDefinition("Key", FieldType.KEY, false, null, null),
054                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
055                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
056                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, false, null, null),
058                new FieldDefinition("EntityAliasTypeName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    /** Creates a new instance of DeleteEntityAliasCommand */
064    public GetEntityAliasCommand(UserVisitPK userVisitPK, GetEntityAliasForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067
068    @Override
069    protected EntityAlias getEntity() {
070        EntityAliasType entityAliasType = EntityAliasTypeLogic.getInstance().getEntityAliasTypeByUniversalSpec(this, form);
071        EntityAlias entityAlias = null;
072
073        if(!hasExecutionErrors()) {
074            entityAlias = EntityAliasTypeLogic.getInstance().getEntityAliasByAlias(this, entityAliasType, form.getAlias());
075        }
076
077        return entityAlias;
078    }
079
080    @Override
081    protected BaseResult getResult(EntityAlias entityAlias) {
082        var coreControl = getCoreControl();
083        var result = CoreResultFactory.getGetEntityAliasResult();
084
085        if(entityAlias != null) {
086            result.setEntityAlias(coreControl.getEntityAliasTransfer(getUserVisit(), entityAlias));
087        }
088
089        return result;
090    }
091    
092}