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.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.BaseMultipleEntitiesCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Collection;
040import java.util.List;
041
042public class GetOfferItemsCommand
043        extends BaseMultipleEntitiesCommand<OfferItem, GetOfferItemsForm> {
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.OfferItem.name(), SecurityRoles.List.name())
053                ))
054        ));
055        
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("OfferName", FieldType.ENTITY_NAME, true, null, 20L)
058        );
059    }
060    
061    /** Creates a new instance of GetOfferItemsCommand */
062    public GetOfferItemsCommand(UserVisitPK userVisitPK, GetOfferItemsForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    private Offer offer;
067    
068    @Override
069    protected Collection<OfferItem> getEntities() {
070        Collection<OfferItem> offerItems = null;
071
072        offer = OfferLogic.getInstance().getOfferByName(this, form.getOfferName());
073
074        if(!hasExecutionErrors()) {
075            var offerItemControl = Session.getModelController(OfferItemControl.class);
076
077            offerItems = offerItemControl.getOfferItemsByOffer(offer);
078        }
079
080        return offerItems;
081    }
082    
083    @Override
084    protected BaseResult getResult(Collection<OfferItem> entities) {
085        var result = OfferResultFactory.getGetOfferItemsResult();
086        
087        if(entities != null) {
088            var offerControl = Session.getModelController(OfferControl.class);
089            var offerItemControl = Session.getModelController(OfferItemControl.class);
090            var userVisit = getUserVisit();
091            
092            if(session.hasLimit(OfferItemFactory.class)) {
093                result.setOfferItemCount(offerItemControl.countOfferItemsByOffer(offer));
094            }
095
096            result.setOffer(offerControl.getOfferTransfer(userVisit, offer));
097            result.setOfferItems(offerItemControl.getOfferItemTransfers(userVisit, entities));
098        }
099        
100        return result;
101    }
102    
103}