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.chain.server.command;
018
019import com.echothree.control.user.chain.common.form.GetChainInstanceForm;
020import com.echothree.control.user.chain.common.result.ChainResultFactory;
021import com.echothree.model.control.chain.server.control.ChainControl;
022import com.echothree.model.control.chain.server.logic.ChainInstanceLogic;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.data.chain.server.entity.ChainInstance;
025import com.echothree.util.common.command.BaseResult;
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 GetChainInstanceCommand
035        extends BaseSingleEntityCommand<ChainInstance, GetChainInstanceForm> {
036    
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("ChainInstanceName", FieldType.ENTITY_NAME, false, null, null),
042                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
043                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
044        );
045    }
046
047    @Inject
048    ChainControl chainControl;
049
050    @Inject
051    ChainInstanceLogic chainInstanceLogic;
052
053    /** Creates a new instance of GetChainInstanceCommand */
054    public GetChainInstanceCommand() {
055        super(null, FORM_FIELD_DEFINITIONS, true);
056    }
057    
058    @Override
059    protected ChainInstance getEntity() {
060        var chainInstance = chainInstanceLogic.getChainInstanceByUniversalSpec(this, form);
061
062        if(chainInstance != null) {
063            sendEvent(chainInstance.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
064        }
065
066        return chainInstance;
067    }
068
069    @Override
070    protected BaseResult getResult(ChainInstance chainInstance) {
071        var result = ChainResultFactory.getGetChainInstanceResult();
072
073        if(chainInstance != null) {
074            result.setChainInstance(chainControl.getChainInstanceTransfer(getUserVisit(), chainInstance));
075        }
076
077        return result;
078    }
079    
080}