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.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 com.echothree.util.server.persistence.Session;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
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    /** Creates a new instance of GetEntityAliasTypesCommand */
066    public GetEntityAliasesCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069
070    EntityAliasType entityAliasType;
071
072    @Override
073    protected void handleForm() {
074        entityAliasType = EntityAliasTypeLogic.getInstance().getEntityAliasTypeByUniversalSpec(this, form);
075    }
076
077    @Override
078    protected Long getTotalEntities() {
079        var entityAliasControl = Session.getModelController(EntityAliasControl.class);
080
081        return hasExecutionErrors() ? null :
082                entityAliasControl.countEntityAliasesByEntityAliasType(entityAliasType);
083    }
084
085
086    @Override
087    protected Collection<EntityAlias> getEntities() {
088        Collection<EntityAlias> entityAliass = null;
089
090        if(!hasExecutionErrors()) {
091            var entityAliasControl = Session.getModelController(EntityAliasControl.class);
092
093            entityAliass = entityAliasControl.getEntityAliasesByEntityAliasType(entityAliasType);
094        }
095
096        return entityAliass;
097    }
098
099    @Override
100    protected BaseResult getResult(Collection<EntityAlias> entities) {
101        var result = CoreResultFactory.getGetEntityAliasesResult();
102
103        if(entities != null) {
104            var entityAliasControl = Session.getModelController(EntityAliasControl.class);
105
106            result.setEntityAliases(entityAliasControl.getEntityAliasTransfers(getUserVisit(), entities));
107        }
108
109        return result;
110    }
111
112}