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.GetEntityLongRangesForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.common.EntityAttributeTypes;
022import com.echothree.model.control.core.server.control.CoreControl;
023import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.core.server.entity.EntityAttribute;
028import com.echothree.model.data.core.server.entity.EntityLongRange;
029import com.echothree.model.data.core.server.factory.EntityLongRangeFactory;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import java.util.Collection;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class GetEntityLongRangesCommand
045        extends BasePaginatedMultipleEntitiesCommand<EntityLongRange, GetEntityLongRangesForm> {
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(List.of(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
054                        new SecurityRoleDefinition(SecurityRoleGroups.EntityLongRange.name(), SecurityRoles.List.name()
055                )))
056        ));
057        
058        FORM_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
061                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null)
062        );
063    }
064    
065    /** Creates a new instance of GetEntityLongRangesCommand */
066    public GetEntityLongRangesCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069    
070    @Inject
071    EntityAttributeLogic entityAttributeLogic;
072
073    private EntityAttribute entityAttribute;
074
075    @Override
076    protected void handleForm() {
077        var componentVendorName = form.getComponentVendorName();
078        var entityTypeName = form.getEntityTypeName();
079        var entityAttributeName = form.getEntityAttributeName();
080
081        entityAttribute = entityAttributeLogic.getEntityAttributeByName(this, componentVendorName, entityTypeName, entityAttributeName);
082
083        if(!hasExecutionErrors()) {
084            var entityAttributeType = entityAttribute.getLastDetail().getEntityAttributeType();
085            var entityAttributeTypeName = entityAttributeType.getEntityAttributeTypeName();
086
087            if(!entityAttributeTypeName.equals(EntityAttributeTypes.LONG.name())) {
088                addExecutionError(ExecutionErrors.InvalidEntityAttributeType.name(), componentVendorName, entityTypeName, entityAttributeName,
089                        entityAttributeTypeName);
090            }
091        }
092    }
093
094    @Override
095    protected Long getTotalEntities() {
096        return hasExecutionErrors() ? null : coreControl.countEntityLongRanges(entityAttribute);
097    }
098
099    @Override
100    protected Collection<EntityLongRange> getEntities() {
101        return hasExecutionErrors() ? null : coreControl.getEntityLongRanges(entityAttribute);
102    }
103
104    @Override
105    protected BaseResult getResult(Collection<EntityLongRange> entities) {
106        var result = CoreResultFactory.getGetEntityLongRangesResult();
107
108        if(entities != null) {
109            var userVisit = getUserVisit();
110
111            result.setEntityAttribute(coreControl.getEntityAttributeTransfer(userVisit, entityAttribute, null));
112
113            if(session.hasLimit(EntityLongRangeFactory.class)) {
114                result.setEntityLongRangeCount(getTotalEntities());
115            }
116
117            result.setEntityLongRanges(coreControl.getEntityLongRangeTransfers(userVisit, entities, null));
118        }
119
120        return result;
121    }
122
123}