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.training.server.command;
018
019import com.echothree.control.user.training.common.form.GetPartyTrainingClassesForm;
020import com.echothree.control.user.training.common.result.TrainingResultFactory;
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.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.control.training.server.control.TrainingControl;
027import com.echothree.model.control.training.server.logic.TrainingClassLogic;
028import com.echothree.model.data.party.server.entity.Party;
029import com.echothree.model.data.training.server.entity.PartyTrainingClass;
030import com.echothree.model.data.training.server.entity.TrainingClass;
031import com.echothree.model.data.training.server.factory.PartyTrainingClassFactory;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import java.util.Collection;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class GetPartyTrainingClassesCommand
047        extends BasePaginatedMultipleEntitiesCommand<PartyTrainingClass, GetPartyTrainingClassesForm> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
056                        new SecurityRoleDefinition(SecurityRoleGroups.PartyTrainingClass.name(), SecurityRoles.List.name())
057                ))
058        ));
059
060        FORM_FIELD_DEFINITIONS = List.of(
061                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, false, null, null)
063        );
064    }
065
066    @Inject
067    PartyControl partyControl;
068
069    @Inject
070    TrainingControl trainingControl;
071
072    @Inject
073    PartyLogic partyLogic;
074
075    @Inject
076    TrainingClassLogic trainingClassLogic;
077
078
079    /** Creates a new instance of GetPartyTrainingClassesCommand */
080    public GetPartyTrainingClassesCommand() {
081        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
082    }
083    
084    private Party party;
085    private TrainingClass trainingClass;
086
087    @Override
088    protected void handleForm() {
089        var partyName = form.getPartyName();
090        var trainingClassName = form.getTrainingClassName();
091        var parameterCount = (partyName == null ? 0 : 1) + (trainingClassName == null ? 0 : 1);
092
093        if(parameterCount == 1) {
094            if(partyName != null) {
095                party = partyLogic.getPartyByName(this, partyName);
096            } else {
097                trainingClass = trainingClassLogic.getTrainingClassByName(this, trainingClassName, false);
098            }
099        } else {
100            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
101        }
102    }
103
104    @Override
105    protected Long getTotalEntities() {
106        Long total = null;
107
108        if(!hasExecutionErrors()) {
109            total = party != null ? trainingControl.countPartyTrainingClassesByParty(party) :
110                    trainingControl.countPartyTrainingClassesByTrainingClass(trainingClass);
111        }
112
113        return total;
114    }
115
116    @Override
117    protected Collection<PartyTrainingClass> getEntities() {
118        Collection<PartyTrainingClass> entities = null;
119
120        if(!hasExecutionErrors()) {
121            entities = party != null ? trainingControl.getPartyTrainingClassesByParty(party) :
122                    trainingControl.getPartyTrainingClassesByTrainingClass(trainingClass);
123        }
124
125        return entities;
126    }
127
128    @Override
129    protected BaseResult getResult(Collection<PartyTrainingClass> entities) {
130        var result = TrainingResultFactory.getGetPartyTrainingClassesResult();
131
132        if(entities != null) {
133            var userVisit = getUserVisit();
134
135            if(party != null) {
136                result.setParty(partyControl.getPartyTransfer(userVisit, party));
137            } else {
138                result.setTrainingClass(trainingControl.getTrainingClassTransfer(userVisit, trainingClass));
139            }
140
141            if(session.hasLimit(PartyTrainingClassFactory.class)) {
142                result.setPartyTrainingClassCount(getTotalEntities());
143            }
144
145            result.setPartyTrainingClasses(trainingControl.getPartyTrainingClassTransfers(userVisit, entities));
146        }
147
148        return result;
149    }
150    
151}