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.GetOfferNameElementForm;
020import com.echothree.control.user.offer.common.result.GetOfferNameElementResult;
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.OfferNameElementControl;
024import com.echothree.model.control.offer.server.logic.OfferNameElementLogic;
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.OfferNameElement;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
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;
041
042public class GetOfferNameElementCommand
043        extends BaseSingleEntityCommand<OfferNameElement, GetOfferNameElementForm> {
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(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.OfferNameElement.name(), SecurityRoles.Review.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("OfferNameElementName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
059                new FieldDefinition("Key", FieldType.KEY, false, null, null),
060                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
061                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetOfferNameElementCommand */
066    public GetOfferNameElementCommand(UserVisitPK userVisitPK, GetOfferNameElementForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069    
070    @Override
071    protected OfferNameElement getEntity() {
072        OfferNameElement offerNameElement = OfferNameElementLogic.getInstance().getOfferNameElementByUniversalSpec(this, form);
073
074        if(offerNameElement != null) {
075            sendEvent(offerNameElement.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
076        }
077
078        return offerNameElement;
079    }
080    
081    @Override
082    protected BaseResult getResult(OfferNameElement offerNameElement) {
083        var offerNameElementControl = Session.getModelController(OfferNameElementControl.class);
084        GetOfferNameElementResult result = OfferResultFactory.getGetOfferNameElementResult();
085
086        if(offerNameElement != null) {
087            result.setOfferNameElement(offerNameElementControl.getOfferNameElementTransfer(getUserVisit(), offerNameElement));
088        }
089
090        return result;
091    }
092    
093}