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