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.GetTrainingClassPagesForm;
020import com.echothree.control.user.training.common.result.TrainingResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.training.server.control.TrainingControl;
025import com.echothree.model.control.training.server.logic.TrainingClassLogic;
026import com.echothree.model.control.training.server.logic.TrainingClassSectionLogic;
027import com.echothree.model.data.training.server.entity.TrainingClassPage;
028import com.echothree.model.data.training.server.entity.TrainingClassSection;
029import com.echothree.model.data.training.server.factory.TrainingClassPageFactory;
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 GetTrainingClassPagesCommand
044        extends BasePaginatedMultipleEntitiesCommand<TrainingClassPage, GetTrainingClassPagesForm> {
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.TrainingClassPage.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("TrainingClassName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("TrainingClassSectionName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    private TrainingControl trainingControl;
065
066    @Inject
067    private TrainingClassLogic trainingClassLogic;
068
069    @Inject
070    private TrainingClassSectionLogic trainingClassSectionLogic;
071    
072    /** Creates a new instance of GetTrainingClassPagesCommand */
073    public GetTrainingClassPagesCommand() {
074        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
075    }
076
077    private TrainingClassSection trainingClassSection;
078
079    @Override
080    protected void handleForm() {
081        var trainingClassName = form.getTrainingClassName();
082        var trainingClass = trainingClassLogic.getTrainingClassByName(this, trainingClassName, false);
083
084        if(!hasExecutionErrors()) {
085            var trainingClassSectionName = form.getTrainingClassSectionName();
086
087            trainingClassSection = trainingClassSectionLogic.getTrainingClassSectionByName(this, trainingClass, trainingClassSectionName);
088        }
089    }
090
091    @Override
092    protected Long getTotalEntities() {
093        return hasExecutionErrors() ? null : trainingControl.countTrainingClassPagesByTrainingClassSection(trainingClassSection);
094    }
095
096    @Override
097    protected Collection<TrainingClassPage> getEntities() {
098        return hasExecutionErrors() ? null : trainingControl.getTrainingClassPages(trainingClassSection);
099    }
100
101    @Override
102    protected BaseResult getResult(Collection<TrainingClassPage> entities) {
103        var result = TrainingResultFactory.getGetTrainingClassPagesResult();
104
105        if(entities != null) {
106            var userVisit = getUserVisit();
107
108            result.setTrainingClassSection(trainingControl.getTrainingClassSectionTransfer(userVisit, trainingClassSection));
109
110            if(session.hasLimit(TrainingClassPageFactory.class)) {
111                result.setTrainingClassPageCount(getTotalEntities());
112            }
113
114            result.setTrainingClassPages(trainingControl.getTrainingClassPageTransfers(userVisit, entities));
115        }
116
117        return result;
118    }
119    
120}