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