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.GetOffersForm;
020import com.echothree.control.user.offer.common.result.OfferResultFactory;
021import com.echothree.model.control.offer.server.control.OfferControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.offer.server.entity.Offer;
026import com.echothree.model.data.offer.server.factory.OfferFactory;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.Collection;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetOffersCommand
041        extends BasePaginatedMultipleEntitiesCommand<Offer, GetOffersForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.Offer.name(), SecurityRoles.List.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of();
055    }
056
057    @Inject
058    OfferControl offerControl;
059
060    
061    /** Creates a new instance of GetOffersCommand */
062    public GetOffersCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066    @Override
067    protected void handleForm() {
068        // No form fields.
069    }
070
071    @Override
072    protected Long getTotalEntities() {
073        return offerControl.countOffers();
074    }
075
076    @Override
077    protected Collection<Offer> getEntities() {
078        return offerControl.getOffers();
079    }
080    
081    @Override
082    protected BaseResult getResult(Collection<Offer> entities) {
083        var result = OfferResultFactory.getGetOffersResult();
084
085        if(entities != null) {
086            if(session.hasLimit(OfferFactory.class)) {
087                result.setOfferCount(getTotalEntities());
088            }
089
090            result.setOffers(offerControl.getOfferTransfers(getUserVisit(), entities));
091        }
092
093        return result;
094    }
095    
096}