001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.sequence.server.command;
018
019import com.echothree.control.user.sequence.common.form.GetSequencesForm;
020import com.echothree.control.user.sequence.common.result.SequenceResultFactory;
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.sequence.server.control.SequenceControl;
025import com.echothree.model.control.sequence.server.logic.SequenceTypeLogic;
026import com.echothree.model.data.sequence.server.entity.Sequence;
027import com.echothree.model.data.sequence.server.entity.SequenceType;
028import com.echothree.model.data.sequence.server.factory.SequenceFactory;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
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.BaseMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collection;
040import java.util.Collections;
041import java.util.List;
042import javax.enterprise.context.RequestScoped;
043
044@RequestScoped
045public class GetSequencesCommand
046        extends BaseMultipleEntitiesCommand<Sequence, GetSequencesForm> {
047
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.Sequence.name(), SecurityRoles.List.name())
056                )))
057        )));
058
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("SequenceTypeName", FieldType.ENTITY_NAME, true, null, null)
061        ));
062    }
063
064    /** Creates a new instance of GetSequencesCommand */
065    public GetSequencesCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068
069    SequenceType sequenceType;
070
071    @Override
072    protected Collection<Sequence> getEntities() {
073        var sequenceTypeName = form.getSequenceTypeName();
074        Collection<Sequence> sequences = null;
075
076        sequenceType = SequenceTypeLogic.getInstance().getSequenceTypeByName(this, sequenceTypeName);
077
078        if(!hasExecutionErrors()) {
079            var sequenceControl = Session.getModelController(SequenceControl.class);
080
081            sequences = sequenceControl.getSequencesBySequenceType(sequenceType);
082        }
083
084        return sequences;
085    }
086
087    @Override
088    protected BaseResult getResult(Collection<Sequence> entities) {
089        var result = SequenceResultFactory.getGetSequencesResult();
090
091        if(entities != null) {
092            var sequenceControl = Session.getModelController(SequenceControl.class);
093
094            if(session.hasLimit(SequenceFactory.class)) {
095                result.setSequenceCount(sequenceControl.countSequencesBySequenceType(sequenceType));
096            }
097
098            result.setSequenceType(sequenceControl.getSequenceTypeTransfer(getUserVisit(), sequenceType));
099            result.setSequences(sequenceControl.getSequenceTransfers(getUserVisit(), entities));
100        }
101
102        return result;
103    }
104
105}