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.scale.server.command;
018
019import com.echothree.control.user.scale.common.form.GetPartyScaleUseForm;
020import com.echothree.control.user.scale.common.result.ScaleResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.logic.PartyLogic;
023import com.echothree.model.control.scale.server.control.ScaleControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.party.server.entity.Party;
027import com.echothree.model.data.scale.server.entity.PartyScaleUse;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
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 java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetPartyScaleUseCommand
042        extends BaseSingleEntityCommand<PartyScaleUse, GetPartyScaleUseForm> {
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.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.PartyScaleUse.name(), SecurityRoles.Review.name())
052                ))
053        ));
054        
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("ScaleUseTypeName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060    
061    @Inject
062    ScaleControl scaleControl;
063
064    @Inject
065    PartyLogic partyLogic;
066
067    /** Creates a new instance of GetPartyScaleUseCommand */
068    public GetPartyScaleUseCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected PartyScaleUse getEntity() {
074        PartyScaleUse partyScaleUse = null;
075        var partyName = form.getPartyName();
076        Party party;
077
078        if(partyName != null) {
079            party = partyLogic.getPartyByName(this, partyName);
080        } else {
081            party = getParty();
082        }
083
084
085        if(!hasExecutionErrors()) {
086            var scaleUseTypeName = form.getScaleUseTypeName();
087            var scaleUseType = scaleControl.getScaleUseTypeByName(scaleUseTypeName);
088
089            if(scaleUseType != null) {
090                partyScaleUse = scaleControl.getPartyScaleUse(party, scaleUseType);
091
092                if(partyScaleUse == null) {
093                    addExecutionError(ExecutionErrors.UnknownPartyScaleUse.name(), party.getLastDetail().getPartyName(), scaleUseTypeName);
094                }
095            } else {
096                addExecutionError(ExecutionErrors.UnknownScaleUseTypeName.name(), scaleUseTypeName);
097            }
098        }
099
100        return partyScaleUse;
101    }
102
103    @Override
104    protected BaseResult getResult(PartyScaleUse partyScaleUse) {
105        var result = ScaleResultFactory.getGetPartyScaleUseResult();
106
107        if(partyScaleUse != null) {
108            result.setPartyScaleUse(scaleControl.getPartyScaleUseTransfer(getUserVisit(), partyScaleUse));
109        }
110
111        return result;
112    }
113    
114}