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.GetEntityAliasesForm;
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.core.server.entity.EntityAliasType;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetEntityAliasesCommand
043        extends BasePaginatedMultipleEntitiesCommand<EntityAlias, GetEntityAliasesForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAlias.name(), SecurityRoles.List.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
058                new FieldDefinition("Uuid", FieldType.UUID, false, null, null),
059                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, false, null, null),
061                new FieldDefinition("EntityAliasTypeName", FieldType.ENTITY_NAME, false, null, null)
062        );
063    }
064
065    @Inject
066    EntityAliasControl entityAliasControl;
067
068    @Inject
069    EntityAliasTypeLogic entityAliasTypeLogic;
070
071    
072    /** Creates a new instance of GetEntityAliasTypesCommand */
073    public GetEntityAliasesCommand() {
074        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
075    }
076
077    EntityAliasType entityAliasType;
078
079    @Override
080    protected void handleForm() {
081        entityAliasType = entityAliasTypeLogic.getEntityAliasTypeByUniversalSpec(this, form);
082    }
083
084    @Override
085    protected Long getTotalEntities() {
086        return hasExecutionErrors() ? null :
087                entityAliasControl.countEntityAliasesByEntityAliasType(entityAliasType);
088    }
089
090
091    @Override
092    protected Collection<EntityAlias> getEntities() {
093        Collection<EntityAlias> entityAliass = null;
094
095        if(!hasExecutionErrors()) {
096            entityAliass = entityAliasControl.getEntityAliasesByEntityAliasType(entityAliasType);
097        }
098
099        return entityAliass;
100    }
101
102    @Override
103    protected BaseResult getResult(Collection<EntityAlias> entities) {
104        var result = CoreResultFactory.getGetEntityAliasesResult();
105
106        if(entities != null) {
107            result.setEntityAliases(entityAliasControl.getEntityAliasTransfers(getUserVisit(), entities));
108        }
109
110        return result;
111    }
112
113}