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.geo.server.command;
018
019import com.echothree.control.user.geo.common.form.GetGeoCodeScopeForm;
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.GeoCodeScopeLogic;
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.GeoCodeScope;
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;
038
039public class GetGeoCodeScopeCommand
040        extends BaseSingleEntityCommand<GeoCodeScope, GetGeoCodeScopeForm> {
041
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeScope.name(), SecurityRoles.Review.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("GeoCodeScopeName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
056                new FieldDefinition("Key", FieldType.KEY, false, null, null),
057                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
058                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
059        );
060    }
061
062    /** Creates a new instance of GetGeoCodeScopeCommand */
063    public GetGeoCodeScopeCommand(UserVisitPK userVisitPK, GetGeoCodeScopeForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066
067    @Override
068    protected GeoCodeScope getEntity() {
069        var geoCodeScope = GeoCodeScopeLogic.getInstance().getGeoCodeScopeByUniversalSpec(this, form, true);
070
071        if(geoCodeScope != null) {
072            sendEvent(geoCodeScope.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
073        }
074
075        return geoCodeScope;
076    }
077
078    @Override
079    protected BaseResult getResult(GeoCodeScope entity) {
080        var geoControl = Session.getModelController(GeoControl.class);
081        var result = GeoResultFactory.getGetGeoCodeScopeResult();
082
083        if(entity != null) {
084            result.setGeoCodeScope(geoControl.getGeoCodeScopeTransfer(getUserVisit(), entity));
085        }
086
087        return result;
088    }
089
090}