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.GetPartyScaleUsesForm;
020import com.echothree.control.user.scale.common.result.ScaleResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.control.party.server.logic.PartyLogic;
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.factory.PartyScaleUseFactory;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetPartyScaleUsesCommand
044        extends BasePaginatedMultipleEntitiesCommand<PartyScaleUse, GetPartyScaleUsesForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.PartyScaleUse.name(), SecurityRoles.List.name())
054                ))
055        ));
056        
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null)
059        );
060    }
061
062    @Inject
063    PartyControl partyControl;
064
065    @Inject
066    ScaleControl scaleControl;
067
068    @Inject
069    PartyLogic partyLogic;
070
071    /** Creates a new instance of GetPartyScaleUsesCommand */
072    public GetPartyScaleUsesCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075
076    private Party party;
077
078    @Override
079    protected void handleForm() {
080        var partyName = form.getPartyName();
081
082        if(partyName != null) {
083            party = partyLogic.getPartyByName(this, partyName);
084        } else {
085            party = getParty();
086        }
087    }
088
089    @Override
090    protected Long getTotalEntities() {
091        return hasExecutionErrors() ? null : scaleControl.countPartyScaleUsesByParty(party);
092    }
093
094    @Override
095    protected Collection<PartyScaleUse> getEntities() {
096        return hasExecutionErrors() ? null : scaleControl.getPartyScaleUsesByParty(party);
097    }
098
099    @Override
100    protected BaseResult getResult(Collection<PartyScaleUse> entities) {
101        var result = ScaleResultFactory.getGetPartyScaleUsesResult();
102
103        if(entities != null) {
104            var userVisit = getUserVisit();
105
106            result.setParty(partyControl.getPartyTransfer(userVisit, party));
107
108            if(session.hasLimit(PartyScaleUseFactory.class)) {
109                result.setPartyScaleUseCount(getTotalEntities());
110            }
111
112            result.setPartyScaleUses(scaleControl.getPartyScaleUseTransfers(userVisit, entities));
113        }
114
115        return result;
116    }
117
118}