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.GetChainForm;
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.ChainLogic;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.chain.server.entity.Chain;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSingleEntityCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetChainCommand
041        extends BaseSingleEntityCommand<Chain, GetChainForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.Chain.name(), SecurityRoles.Review.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("ChainName", 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    @Inject
064    ChainControl chainControl;
065
066    @Inject
067    ChainLogic chainLogic;
068
069    /** Creates a new instance of GetChainCommand */
070    public GetChainCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
072    }
073
074    @Override
075    protected Chain getEntity() {
076        var chain = chainLogic.getChainByUniversalSpec(this, form, true);
077
078        if(chain != null) {
079            sendEvent(chain.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
080        }
081
082        return chain;
083    }
084
085    @Override
086    protected BaseResult getResult(Chain chain) {
087        var result = ChainResultFactory.getGetChainResult();
088
089        if(chain != null) {
090            result.setChain(chainControl.getChainTransfer(getUserVisit(), chain));
091        }
092
093        return result;
094    }
095
096}