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.GetEntityInstancesForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.EntityInstanceControl;
022import com.echothree.model.control.core.server.logic.EntityTypeLogic;
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.EntityInstance;
027import com.echothree.model.data.core.server.entity.EntityType;
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;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetEntityInstancesCommand
042        extends BasePaginatedMultipleEntitiesCommand<EntityInstance, GetEntityInstancesForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.EntityInstance.name(), SecurityRoles.List.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null)
058        );
059    }
060
061    @Inject
062    EntityInstanceControl entityInstanceControl;
063
064    @Inject
065    EntityTypeLogic entityTypeLogic;
066
067    
068    /** Creates a new instance of GetEntityInstancesCommand */
069    public GetEntityInstancesCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
071    }
072
073    EntityType entityType;
074
075    @Override
076    protected void handleForm() {
077        var componentVendorName = form.getComponentVendorName();
078        var entityTypeName = form.getEntityTypeName();
079
080        entityType = entityTypeLogic.getEntityTypeByName(this, componentVendorName, entityTypeName);
081    }
082
083    @Override
084    protected Long getTotalEntities() {
085        return hasExecutionErrors() ? null : entityInstanceControl.countEntityInstancesByEntityType(entityType);
086    }
087
088    @Override
089    protected Collection<EntityInstance> getEntities() {
090        Collection<EntityInstance> entities = null;
091
092        if(!hasExecutionErrors()) {
093            entities = entityInstanceControl.getEntityInstancesByEntityType(entityType);
094        }
095
096        return entities;
097    }
098
099    @Override
100    protected BaseResult getResult(Collection<EntityInstance> entities) {
101        var result = CoreResultFactory.getGetEntityInstancesResult();
102
103        if(entities != null) {
104            result.setEntityType(entityTypeControl.getEntityTypeTransfer(getUserVisit(), entityType));
105            result.setEntityInstances(entityInstanceControl.getEntityInstanceTransfers(getUserVisit(), entities,
106                    false, false, false, false));
107        }
108
109        return result;
110    }
111    
112}