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.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.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetSequencesCommand
043        extends BasePaginatedMultipleEntitiesCommand<Sequence, GetSequencesForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.Sequence.name(), SecurityRoles.List.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("SequenceTypeName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060
061    @Inject
062    SequenceControl sequenceControl;
063
064    @Inject
065    SequenceTypeLogic sequenceTypeLogic;
066
067    /** Creates a new instance of GetSequencesCommand */
068    public GetSequencesCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
070    }
071
072    SequenceType sequenceType;
073
074    @Override
075    protected void handleForm() {
076        sequenceType = sequenceTypeLogic.getSequenceTypeByName(this, form.getSequenceTypeName());
077    }
078
079    @Override
080    protected Long getTotalEntities() {
081        return hasExecutionErrors() ? null : sequenceControl.countSequencesBySequenceType(sequenceType);
082    }
083
084    @Override
085    protected Collection<Sequence> getEntities() {
086        return hasExecutionErrors() ? null : sequenceControl.getSequencesBySequenceType(sequenceType);
087    }
088
089    @Override
090    protected BaseResult getResult(Collection<Sequence> entities) {
091        var result = SequenceResultFactory.getGetSequencesResult();
092
093        if(entities != null) {
094            if(session.hasLimit(SequenceFactory.class)) {
095                result.setSequenceCount(getTotalEntities());
096            }
097
098            result.setSequenceType(sequenceControl.getSequenceTypeTransfer(getUserVisit(), sequenceType));
099            result.setSequences(sequenceControl.getSequenceTransfers(getUserVisit(), entities));
100        }
101
102        return result;
103    }
104
105}