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.workrequirement.server.command;
018
019import com.echothree.control.user.workrequirement.common.form.GetWorkRequirementForm;
020import com.echothree.control.user.workrequirement.common.result.WorkRequirementResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.workrequirement.server.control.WorkRequirementControl;
023import com.echothree.model.data.workrequirement.server.entity.WorkRequirement;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSingleEntityCommand;
029import java.util.List;
030import javax.enterprise.context.Dependent;
031import javax.inject.Inject;
032
033@Dependent
034public class GetWorkRequirementCommand
035        extends BaseSingleEntityCommand<WorkRequirement, GetWorkRequirementForm> {
036    
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("WorkRequirementName", FieldType.ENTITY_NAME, true, null, null)
042        );
043    }
044
045    @Inject
046    WorkRequirementControl workRequirementControl;
047    
048    /** Creates a new instance of GetWorkRequirementCommand */
049    public GetWorkRequirementCommand() {
050        super(null, FORM_FIELD_DEFINITIONS, true);
051    }
052    
053    @Override
054    protected WorkRequirement getEntity() {
055        var workRequirementName = form.getWorkRequirementName();
056        var workRequirement = workRequirementControl.getWorkRequirementByName(workRequirementName);
057
058        if(workRequirement != null) {
059            sendEvent(workRequirement.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
060        } else {
061            addExecutionError(ExecutionErrors.UnknownWorkRequirementName.name(), workRequirementName);
062        }
063
064        return workRequirement;
065    }
066
067    @Override
068    protected BaseResult getResult(WorkRequirement workRequirement) {
069        var result = WorkRequirementResultFactory.getGetWorkRequirementResult();
070
071        if(workRequirement != null) {
072            result.setWorkRequirement(workRequirementControl.getWorkRequirementTransfer(getUserVisit(), workRequirement));
073        }
074
075        return result;
076    }
077    
078}