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.GetRelatedItemsForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.item.server.control.ItemControl;
022import com.echothree.model.data.item.server.entity.Item;
023import com.echothree.model.data.item.server.entity.RelatedItem;
024import com.echothree.model.data.item.server.entity.RelatedItemType;
025import com.echothree.model.data.item.server.factory.RelatedItemFactory;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
032import com.echothree.util.server.persistence.Session;
033import java.util.Arrays;
034import java.util.Collection;
035import java.util.Collections;
036import java.util.List;
037
038public class GetRelatedItemsCommand
039        extends BaseMultipleEntitiesCommand<RelatedItem, GetRelatedItemsForm> {
040
041    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
046            new FieldDefinition("RelatedItemTypeName", FieldType.ENTITY_NAME, false, null, null),
047            new FieldDefinition("FromItemName", FieldType.ENTITY_NAME, false, null, null),
048            new FieldDefinition("ToItemName", FieldType.ENTITY_NAME, false, null, null)
049        ));
050    }
051    
052    /** Creates a new instance of GetRelatedItemsCommand */
053    public GetRelatedItemsCommand(UserVisitPK userVisitPK, GetRelatedItemsForm form) {
054        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
055    }
056
057    RelatedItemType relatedItemType;
058    Item fromItem;
059    Item toItem;
060    Long relatedItemCount;
061
062    @Override
063    protected Collection<RelatedItem> getEntities() {
064        var fromItemName = form.getFromItemName();
065        var toItemName = form.getToItemName();
066        var parameterCount = (fromItemName == null ? 0 : 1) + (toItemName == null ? 0 : 1);
067        Collection<RelatedItem> relatedItems = null;
068
069        if(parameterCount == 1) {
070            var itemControl = Session.getModelController(ItemControl.class);
071            var relatedItemTypeName = form.getRelatedItemTypeName();
072
073            relatedItemType = relatedItemTypeName == null ? null : itemControl.getRelatedItemTypeByName(relatedItemTypeName);
074
075            if(relatedItemTypeName == null || relatedItemType != null) {
076                fromItem = fromItemName == null ? null : itemControl.getItemByName(fromItemName);
077
078                if(fromItemName == null || fromItem != null) {
079                    toItem = toItemName == null ? null : itemControl.getItemByName(toItemName);
080
081                    if(toItemName == null || toItem != null) {
082                        if(relatedItemType == null) {
083                            if(fromItem != null) {
084                                if(session.hasLimit(RelatedItemFactory.class)) {
085                                    relatedItemCount = itemControl.countRelatedItemsByFromItem(fromItem);
086                                }
087
088                                relatedItems = itemControl.getRelatedItemsByFromItem(fromItem);
089                            } else if(toItem != null) {
090                                if(session.hasLimit(RelatedItemFactory.class)) {
091                                    relatedItemCount = itemControl.countRelatedItemsByToItem(toItem);
092                                }
093
094                                relatedItems = itemControl.getRelatedItemsByToItem(toItem);
095                            }
096                        } else {
097                            if(fromItem != null) {
098                                if(session.hasLimit(RelatedItemFactory.class)) {
099                                    relatedItemCount = itemControl.countRelatedItemsByRelatedItemTypeAndFromItem(relatedItemType, fromItem);
100                                }
101
102                                relatedItems = itemControl.getRelatedItemsByRelatedItemTypeAndFromItem(relatedItemType, fromItem);
103                            } else if(toItem != null) {
104                                if(session.hasLimit(RelatedItemFactory.class)) {
105                                    relatedItemCount = itemControl.countRelatedItemsByRelatedItemTypeAndToItem(relatedItemType, toItem);
106                                }
107
108                                relatedItems = itemControl.getRelatedItemsByRelatedItemTypeAndToItem(relatedItemType, toItem);
109                            }
110                        }
111                    } else {
112                        addExecutionError(ExecutionErrors.UnknownToItemName.name(), toItemName);
113                    }
114                } else {
115                    addExecutionError(ExecutionErrors.UnknownFromItemName.name(), fromItemName);
116                }
117            } else {
118                addExecutionError(ExecutionErrors.UnknownRelatedItemTypeName.name(), relatedItemTypeName);
119            }
120        } else {
121            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
122        }
123
124        return relatedItems;
125    }
126
127    @Override
128    protected BaseResult getResult(Collection<RelatedItem> entities) {
129        var result = ItemResultFactory.getGetRelatedItemsResult();
130
131        if(entities != null) {
132            var itemControl = Session.getModelController(ItemControl.class);
133            var userVisit = getUserVisit();
134
135            if(relatedItemType != null) {
136                result.setRelatedItemType(itemControl.getRelatedItemTypeTransfer(userVisit, relatedItemType));
137            }
138
139            if(fromItem != null) {
140                result.setFromItem(itemControl.getItemTransfer(userVisit, fromItem));
141            }
142
143            if(toItem != null) {
144                result.setToItem(itemControl.getItemTransfer(userVisit, toItem));
145            }
146
147            if(session.hasLimit(RelatedItemFactory.class)) {
148                result.setRelatedItemCount(relatedItemCount);
149            }
150
151            result.setRelatedItems(itemControl.getRelatedItemTransfers(userVisit, entities));
152        }
153
154        return result;
155    }
156
157}