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.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.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.Arrays;
038import java.util.Collection;
039import java.util.Collections;
040import java.util.List;
041import javax.enterprise.context.RequestScoped;
042
043@RequestScoped
044public class GetEntityInstancesCommand
045        extends BasePaginatedMultipleEntitiesCommand<EntityInstance, GetEntityInstancesForm> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.EntityInstance.name(), SecurityRoles.List.name())
055                        )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetEntityInstancesCommand */
065    public GetEntityInstancesCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068
069    EntityType entityType;
070
071    @Override
072    protected void handleForm() {
073        var componentVendorName = form.getComponentVendorName();
074        var entityTypeName = form.getEntityTypeName();
075
076        entityType = EntityTypeLogic.getInstance().getEntityTypeByName(this, componentVendorName, entityTypeName);
077    }
078
079    @Override
080    protected Long getTotalEntities() {
081        var entityInstanceControl = Session.getModelController(EntityInstanceControl.class);
082
083        return hasExecutionErrors() ? null : entityInstanceControl.countEntityInstancesByEntityType(entityType);
084    }
085
086    @Override
087    protected Collection<EntityInstance> getEntities() {
088        Collection<EntityInstance> entities = null;
089
090        if(!hasExecutionErrors()) {
091            var entityInstanceControl = Session.getModelController(EntityInstanceControl.class);
092
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            var entityInstanceControl = Session.getModelController(EntityInstanceControl.class);
105
106            result.setEntityInstances(entityInstanceControl.getEntityInstanceTransfers(getUserVisit(), entities,
107                    false, false, false, false));
108        }
109
110        return result;
111    }
112    
113}