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.offer.server.command;
018
019import com.echothree.control.user.offer.common.form.GetOfferItemsForm;
020import com.echothree.control.user.offer.common.result.OfferResultFactory;
021import com.echothree.model.control.offer.server.control.OfferControl;
022import com.echothree.model.control.offer.server.control.OfferItemControl;
023import com.echothree.model.control.offer.server.logic.OfferLogic;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.offer.server.entity.Offer;
028import com.echothree.model.data.offer.server.entity.OfferItem;
029import com.echothree.model.data.offer.server.factory.OfferItemFactory;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import java.util.Collection;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class GetOfferItemsCommand
045        extends BasePaginatedMultipleEntitiesCommand<OfferItem, GetOfferItemsForm> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
054                        new SecurityRoleDefinition(SecurityRoleGroups.OfferItem.name(), SecurityRoles.List.name())
055                ))
056        ));
057        
058        FORM_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("OfferName", FieldType.ENTITY_NAME, true, null, 20L)
060        );
061    }
062    
063    /** Creates a new instance of GetOfferItemsCommand */
064    public GetOfferItemsCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Inject
069    OfferControl offerControl;
070
071    @Inject
072    OfferItemControl offerItemControl;
073
074    @Inject
075    OfferLogic offerLogic;
076
077    private Offer offer;
078
079    @Override
080    protected void handleForm() {
081        offer = offerLogic.getOfferByName(this, form.getOfferName());
082    }
083
084    @Override
085    protected Long getTotalEntities() {
086        return hasExecutionErrors() ? null : offerItemControl.countOfferItemsByOffer(offer);
087    }
088
089    @Override
090    protected Collection<OfferItem> getEntities() {
091        return hasExecutionErrors() ? null : offerItemControl.getOfferItemsByOffer(offer);
092    }
093    
094    @Override
095    protected BaseResult getResult(Collection<OfferItem> entities) {
096        var result = OfferResultFactory.getGetOfferItemsResult();
097        
098        if(entities != null) {
099            var userVisit = getUserVisit();
100            
101            result.setOffer(offerControl.getOfferTransfer(userVisit, offer));
102
103            if(session.hasLimit(OfferItemFactory.class)) {
104                result.setOfferItemCount(getTotalEntities());
105            }
106
107            result.setOfferItems(offerItemControl.getOfferItemTransfers(userVisit, entities));
108        }
109        
110        return result;
111    }
112    
113}