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.GetUseForm;
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.UseControl;
023import com.echothree.model.control.offer.server.control.UseNameElementControl;
024import com.echothree.model.control.offer.server.logic.UseLogic;
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.Use;
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.List;
039import javax.enterprise.context.Dependent;
040
041@Dependent
042public class GetUseCommand
043        extends BaseSingleEntityCommand<Use, GetUseForm> {
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.Use.name(), SecurityRoles.Review.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("UseName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
059                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
060        );
061    }
062    
063    /** Creates a new instance of GetUseCommand */
064    public GetUseCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected Use getEntity() {
070        var use = UseLogic.getInstance().getUseByUniversalSpec(this, form, true);
071
072        if(!hasExecutionErrors()) {
073            sendEvent(use.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
074        }
075        
076        return use;
077    }
078    
079    @Override
080    protected BaseResult getResult(Use use) {
081        var result = OfferResultFactory.getGetUseResult();
082        
083        if(use != null) {
084            var useControl = Session.getModelController(UseControl.class);
085            var useNameElementControl = Session.getModelController(UseNameElementControl.class);
086            var userVisit = getUserVisit();
087            
088            result.setUse(useControl.getUseTransfer(userVisit, use));
089            result.setUseNameElements(useNameElementControl.getUseNameElementTransfers(userVisit));
090        }
091        
092        return result;
093    }
094    
095}