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.scale.server.command;
018
019import com.echothree.control.user.scale.common.form.GetPartyScaleUseForm;
020import com.echothree.control.user.scale.common.result.GetPartyScaleUseResult;
021import com.echothree.control.user.scale.common.result.ScaleResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.scale.server.control.ScaleControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.party.server.entity.Party;
028import com.echothree.model.data.scale.server.entity.PartyScaleUse;
029import com.echothree.model.data.scale.server.entity.ScaleUseType;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class GetPartyScaleUseCommand
045        extends BaseSimpleCommand<GetPartyScaleUseForm> {
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(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.PartyScaleUse.name(), SecurityRoles.Review.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("ScaleUseTypeName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetPartyScaleUseCommand */
065    public GetPartyScaleUseCommand(UserVisitPK userVisitPK, GetPartyScaleUseForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        GetPartyScaleUseResult result = ScaleResultFactory.getGetPartyScaleUseResult();
072        String partyName = form.getPartyName();
073        Party party = null;
074
075        if(partyName != null) {
076            var partyControl = Session.getModelController(PartyControl.class);
077
078            party = partyControl.getPartyByName(partyName);
079
080            if(party == null) {
081                addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
082            }
083        } else {
084            party = getParty();
085        }
086
087        if(!hasExecutionErrors()) {
088            var scaleControl = Session.getModelController(ScaleControl.class);
089            String scaleUseTypeName = form.getScaleUseTypeName();
090            ScaleUseType scaleUseType = scaleControl.getScaleUseTypeByName(scaleUseTypeName);
091
092            if(scaleUseType != null) {
093                PartyScaleUse partyScaleUse = scaleControl.getPartyScaleUse(party, scaleUseType);
094
095                if(partyScaleUse != null) {
096                    result.setPartyScaleUse(scaleControl.getPartyScaleUseTransfer(getUserVisit(), partyScaleUse));
097                } else {
098                    addExecutionError(ExecutionErrors.UnknownPartyScaleUse.name(), party.getLastDetail().getPartyName(), scaleUseTypeName);
099                }
100            } else {
101                addExecutionError(ExecutionErrors.UnknownScaleUseTypeName.name(), scaleUseTypeName);
102            }
103        }
104
105        return result;
106    }
107    
108}