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.GetOfferForm;
020import com.echothree.control.user.offer.common.result.GetOfferResult;
021import com.echothree.control.user.offer.common.result.OfferResultFactory;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.offer.server.control.OfferControl;
024import com.echothree.model.control.offer.server.control.OfferNameElementControl;
025import com.echothree.model.control.offer.server.logic.OfferLogic;
026import com.echothree.model.control.offer.server.logic.UseTypeLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.offer.server.entity.Offer;
031import com.echothree.model.data.offer.server.entity.UseType;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.model.data.user.server.entity.UserVisit;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.common.command.BaseResult;
038import com.echothree.util.server.control.BaseSingleEntityCommand;
039import com.echothree.util.server.control.CommandSecurityDefinition;
040import com.echothree.util.server.control.PartyTypeDefinition;
041import com.echothree.util.server.control.SecurityRoleDefinition;
042import com.echothree.util.server.persistence.Session;
043import java.util.Arrays;
044import java.util.Collections;
045import java.util.List;
046
047public class GetOfferCommand
048        extends BaseSingleEntityCommand<Offer, GetOfferForm> {
049    
050    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
051    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
057                        new SecurityRoleDefinition(SecurityRoleGroups.Offer.name(), SecurityRoles.Review.name())
058                        )))
059                )));
060        
061        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("OfferName", FieldType.ENTITY_NAME, false, null, null),
063                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
064                new FieldDefinition("Key", FieldType.KEY, false, null, null),
065                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
066                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
067                ));
068    }
069    
070    /** Creates a new instance of GetOfferCommand */
071    public GetOfferCommand(UserVisitPK userVisitPK, GetOfferForm form) {
072        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
073    }
074    
075    @Override
076    protected Offer getEntity() {
077        Offer offer = OfferLogic.getInstance().getOfferByUniversalSpec(this, form, true);
078
079        if(offer != null) {
080            sendEvent(offer.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
081        }
082
083        return offer;
084    }
085    
086    @Override
087    protected BaseResult getResult(Offer offer) {
088        var result = OfferResultFactory.getGetOfferResult();
089        
090        if(offer != null) {
091            var offerControl = Session.getModelController(OfferControl.class);
092            var offerNameElementControl = Session.getModelController(OfferNameElementControl.class);
093            UserVisit userVisit = getUserVisit();
094            
095            result.setOffer(offerControl.getOfferTransfer(userVisit, offer));
096            result.setOfferNameElements(offerNameElementControl.getOfferNameElementTransfers(userVisit));
097        }
098        
099        return result;
100    }
101    
102}