001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.item.server.command;
018
019import com.echothree.control.user.item.common.form.GetRelatedItemForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.item.server.control.ItemControl;
022import com.echothree.model.control.item.server.logic.RelatedItemTypeLogic;
023import com.echothree.model.data.item.server.entity.RelatedItem;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSingleEntityCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.Arrays;
032import java.util.Collections;
033import java.util.List;
034import javax.enterprise.context.RequestScoped;
035
036@RequestScoped
037public class GetRelatedItemCommand
038        extends BaseSingleEntityCommand<RelatedItem, GetRelatedItemForm> {
039
040    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
045            new FieldDefinition("RelatedItemTypeName", FieldType.ENTITY_NAME, true, null, null),
046            new FieldDefinition("FromItemName", FieldType.ENTITY_NAME, true, null, null),
047            new FieldDefinition("ToItemName", FieldType.ENTITY_NAME, true, null, null)
048        ));
049    }
050    
051    /** Creates a new instance of GetRelatedItemCommand */
052    public GetRelatedItemCommand() {
053        super(null, FORM_FIELD_DEFINITIONS, false);
054    }
055
056
057    @Override
058    protected RelatedItem getEntity() {
059        var relatedItemType = RelatedItemTypeLogic.getInstance().getRelatedItemTypeByName(this, form.getRelatedItemTypeName());
060        RelatedItem relatedItem = null;
061
062        if(relatedItemType != null) {
063            var itemControl = Session.getModelController(ItemControl.class);
064            var fromItemName = form.getFromItemName();
065            var fromItem = itemControl.getItemByName(fromItemName);
066
067            if(fromItem != null) {
068                var toItemName = form.getToItemName();
069                var toItem = itemControl.getItemByName(toItemName);
070
071                if(toItem != null) {
072                    relatedItem = itemControl.getRelatedItem(relatedItemType, fromItem, toItem);
073
074                    if(relatedItem == null) {
075                        addExecutionError(ExecutionErrors.UnknownRelatedItem.name(),
076                                relatedItemType.getLastDetail().getRelatedItemTypeName(),
077                                fromItem.getLastDetail().getItemName(), toItem.getLastDetail().getItemName());
078                    }
079                } else {
080                    addExecutionError(ExecutionErrors.UnknownToItemName.name(), toItemName);
081                }
082            } else {
083                addExecutionError(ExecutionErrors.UnknownFromItemName.name(), fromItemName);
084            }
085        }
086
087        return relatedItem;
088    }
089
090    @Override
091    protected BaseResult getResult(RelatedItem relatedItem) {
092        var result = ItemResultFactory.getGetRelatedItemResult();
093
094        if(relatedItem != null) {
095            var itemControl = Session.getModelController(ItemControl.class);
096
097            result.setRelatedItem(itemControl.getRelatedItemTransfer(getUserVisit(), relatedItem));
098        }
099
100        return result;
101    }
102
103}