001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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;
042
043public class GetSequencesCommand
044        extends BaseMultipleEntitiesCommand<Sequence, GetSequencesForm> {
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(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.Sequence.name(), SecurityRoles.List.name())
054                )))
055        )));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("SequenceTypeName", FieldType.ENTITY_NAME, true, null, null)
059        ));
060    }
061
062    /** Creates a new instance of GetSequencesCommand */
063    public GetSequencesCommand(UserVisitPK userVisitPK, GetSequencesForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066
067    SequenceType sequenceType;
068
069    @Override
070    protected Collection<Sequence> getEntities() {
071        var sequenceTypeName = form.getSequenceTypeName();
072        Collection<Sequence> sequences = null;
073
074        sequenceType = SequenceTypeLogic.getInstance().getSequenceTypeByName(this, sequenceTypeName);
075
076        if(!hasExecutionErrors()) {
077            var sequenceControl = Session.getModelController(SequenceControl.class);
078
079            sequences = sequenceControl.getSequencesBySequenceType(sequenceType);
080        }
081
082        return sequences;
083    }
084
085    @Override
086    protected BaseResult getResult(Collection<Sequence> entities) {
087        var result = SequenceResultFactory.getGetSequencesResult();
088
089        if(entities != null) {
090            var sequenceControl = Session.getModelController(SequenceControl.class);
091
092            if(session.hasLimit(SequenceFactory.class)) {
093                result.setSequenceCount(sequenceControl.countSequencesBySequenceType(sequenceType));
094            }
095
096            result.setSequenceType(sequenceControl.getSequenceTypeTransfer(getUserVisit(), sequenceType));
097            result.setSequences(sequenceControl.getSequenceTransfers(getUserVisit(), entities));
098        }
099
100        return result;
101    }
102
103}