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.GetEntityAliasesForm;
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.BasePaginatedMultipleEntitiesCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.Collection;
036import java.util.List;
037
038public class GetEntityAliasesCommand
039        extends BasePaginatedMultipleEntitiesCommand<EntityAlias, GetEntityAliasesForm> {
040
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAlias.name(), SecurityRoles.List.name())
049                ))
050        ));
051
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
054                new FieldDefinition("Key", FieldType.KEY, false, null, null),
055                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
056                new FieldDefinition("Ulid", FieldType.ULID, 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        );
061    }
062    
063    /** Creates a new instance of GetEntityAliasTypesCommand */
064    public GetEntityAliasesCommand(UserVisitPK userVisitPK, GetEntityAliasesForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067
068    EntityAliasType entityAliasType;
069
070    @Override
071    protected void handleForm() {
072        entityAliasType = EntityAliasTypeLogic.getInstance().getEntityAliasTypeByUniversalSpec(this, form);
073    }
074
075    @Override
076    protected Long getTotalEntities() {
077        return hasExecutionErrors() ? null :
078                getCoreControl().countEntityAliasesByEntityAliasType(entityAliasType);
079    }
080
081
082    @Override
083    protected Collection<EntityAlias> getEntities() {
084        Collection<EntityAlias> entityAliass = null;
085
086        if(!hasExecutionErrors()) {
087            var coreControl = getCoreControl();
088
089            entityAliass = coreControl.getEntityAliasesByEntityAliasType(entityAliasType);
090        }
091
092        return entityAliass;
093    }
094
095    @Override
096    protected BaseResult getResult(Collection<EntityAlias> entities) {
097        var result = CoreResultFactory.getGetEntityAliasesResult();
098
099        if(entities != null) {
100            var coreControl = getCoreControl();
101
102            result.setEntityAliases(coreControl.getEntityAliasTransfers(getUserVisit(), entities));
103        }
104
105        return result;
106    }
107
108}