001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.GetOfferForm;
020import com.echothree.control.user.offer.common.result.OfferResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.offer.server.control.OfferControl;
023import com.echothree.model.control.offer.server.control.OfferNameElementControl;
024import com.echothree.model.control.offer.server.logic.OfferLogic;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.offer.server.entity.Offer;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSingleEntityCommand;
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.Collections;
040import java.util.List;
041import javax.enterprise.context.RequestScoped;
042
043@RequestScoped
044public class GetOfferCommand
045        extends BaseSingleEntityCommand<Offer, GetOfferForm> {
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(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.Offer.name(), SecurityRoles.Review.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("OfferName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
061                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetOfferCommand */
066    public GetOfferCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069    
070    @Override
071    protected Offer getEntity() {
072        var offer = OfferLogic.getInstance().getOfferByUniversalSpec(this, form, true);
073
074        if(offer != null) {
075            sendEvent(offer.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
076        }
077
078        return offer;
079    }
080    
081    @Override
082    protected BaseResult getResult(Offer offer) {
083        var result = OfferResultFactory.getGetOfferResult();
084        
085        if(offer != null) {
086            var offerControl = Session.getModelController(OfferControl.class);
087            var offerNameElementControl = Session.getModelController(OfferNameElementControl.class);
088            var userVisit = getUserVisit();
089            
090            result.setOffer(offerControl.getOfferTransfer(userVisit, offer));
091            result.setOfferNameElements(offerNameElementControl.getOfferNameElementTransfers(userVisit));
092        }
093        
094        return result;
095    }
096    
097}