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.geo.server.command;
018
019import com.echothree.control.user.geo.common.form.GetGeoCodeForm;
020import com.echothree.control.user.geo.common.result.GeoResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.geo.server.control.GeoControl;
023import com.echothree.model.control.geo.server.logic.GeoCodeLogic;
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.geo.server.entity.GeoCode;
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.BaseSingleEntityCommand;
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.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetGeoCodeCommand
042        extends BaseSingleEntityCommand<GeoCode, GetGeoCodeForm> {
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.CUSTOMER.name(), null),
051                new PartyTypeDefinition(PartyTypes.VENDOR.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCode.name(), SecurityRoles.Review.name())
054                ))
055        ));
056        
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
060                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
061        );
062    }
063    
064    /** Creates a new instance of GetGeoCodeCommand */
065    public GetGeoCodeCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068
069    @Override
070    protected GeoCode getEntity() {
071        var geoCode = GeoCodeLogic.getInstance().getGeoCodeByUniversalSpec(this, form);
072        
073        if(!hasExecutionErrors()) {
074            sendEvent(geoCode.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
075        }
076
077        return geoCode;
078    }
079
080    @Override
081    protected BaseResult getResult(GeoCode entity) {
082        var result = GeoResultFactory.getGetGeoCodeResult();
083
084        if(entity != null) {
085            var geoControl = Session.getModelController(GeoControl.class);
086
087            result.setGeoCode(geoControl.getGeoCodeTransfer(getUserVisit(), entity));
088        }
089
090        return result;
091    }
092
093}