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.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.util.common.command.BaseResult;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
031import com.echothree.util.server.persistence.Session;
032import java.util.Collection;
033import java.util.List;
034import javax.enterprise.context.RequestScoped;
035
036@RequestScoped
037public class GetRelatedItemsCommand
038        extends BasePaginatedMultipleEntitiesCommand<RelatedItem, GetRelatedItemsForm> {
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 = List.of(
045                new FieldDefinition("RelatedItemTypeName", FieldType.ENTITY_NAME, false, null, null),
046                new FieldDefinition("FromItemName", FieldType.ENTITY_NAME, false, null, null),
047                new FieldDefinition("ToItemName", FieldType.ENTITY_NAME, false, null, null)
048        );
049    }
050    
051    /** Creates a new instance of GetRelatedItemsCommand */
052    public GetRelatedItemsCommand() {
053        super(null, FORM_FIELD_DEFINITIONS, true);
054    }
055
056    RelatedItemType relatedItemType;
057    Item fromItem;
058    Item toItem;
059
060    @Override
061    protected void handleForm() {
062        var fromItemName = form.getFromItemName();
063        var toItemName = form.getToItemName();
064        var parameterCount = (fromItemName == null ? 0 : 1) + (toItemName == null ? 0 : 1);
065
066        if(parameterCount == 1) {
067            var itemControl = Session.getModelController(ItemControl.class);
068            var relatedItemTypeName = form.getRelatedItemTypeName();
069
070            relatedItemType = relatedItemTypeName == null ? null : itemControl.getRelatedItemTypeByName(relatedItemTypeName);
071
072            if(relatedItemTypeName == null || relatedItemType != null) {
073                fromItem = fromItemName == null ? null : itemControl.getItemByName(fromItemName);
074
075                if(fromItemName == null || fromItem != null) {
076                    toItem = toItemName == null ? null : itemControl.getItemByName(toItemName);
077
078                    if(toItemName != null && toItem == null) {
079                        addExecutionError(ExecutionErrors.UnknownToItemName.name(), toItemName);
080                    }
081                } else {
082                    addExecutionError(ExecutionErrors.UnknownFromItemName.name(), fromItemName);
083                }
084            } else {
085                addExecutionError(ExecutionErrors.UnknownRelatedItemTypeName.name(), relatedItemTypeName);
086            }
087        } else {
088            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
089        }
090    }
091
092    @Override
093    protected Long getTotalEntities() {
094        var itemControl = Session.getModelController(ItemControl.class);
095        Long totalEntities = null;
096
097        if(!hasExecutionErrors()) {
098            if(relatedItemType == null) {
099                if(fromItem != null) {
100                    totalEntities = itemControl.countRelatedItemsByFromItem(fromItem);
101                } else {
102                    totalEntities = itemControl.countRelatedItemsByToItem(toItem);
103                }
104            } else {
105                if(fromItem != null) {
106                    totalEntities = itemControl.countRelatedItemsByRelatedItemTypeAndFromItem(relatedItemType, fromItem);
107                } else {
108                    totalEntities = itemControl.countRelatedItemsByRelatedItemTypeAndToItem(relatedItemType, toItem);
109                }
110            }
111        }
112
113        return totalEntities;
114    }
115
116    @Override
117    protected Collection<RelatedItem> getEntities() {
118        Collection<RelatedItem> entities = null;
119
120        if(!hasExecutionErrors()) {
121            var itemControl = Session.getModelController(ItemControl.class);
122
123            if(relatedItemType == null) {
124                if(fromItem != null) {
125                    entities = itemControl.getRelatedItemsByFromItem(fromItem);
126                } else if(toItem != null) {
127                    entities = itemControl.getRelatedItemsByToItem(toItem);
128                }
129            } else {
130                if(fromItem != null) {
131                    entities = itemControl.getRelatedItemsByRelatedItemTypeAndFromItem(relatedItemType, fromItem);
132                } else if(toItem != null) {
133                    entities = itemControl.getRelatedItemsByRelatedItemTypeAndToItem(relatedItemType, toItem);
134                }
135            }
136        }
137
138        return entities;
139    }
140
141    @Override
142    protected BaseResult getResult(Collection<RelatedItem> entities) {
143        var result = ItemResultFactory.getGetRelatedItemsResult();
144
145        if(entities != null) {
146            var itemControl = Session.getModelController(ItemControl.class);
147            var userVisit = getUserVisit();
148
149            if(session.hasLimit(RelatedItemFactory.class)) {
150                result.setRelatedItemCount(getTotalEntities());
151            }
152
153            if(relatedItemType != null) {
154                result.setRelatedItemType(itemControl.getRelatedItemTypeTransfer(userVisit, relatedItemType));
155            }
156
157            if(fromItem != null) {
158                result.setFromItem(itemControl.getItemTransfer(userVisit, fromItem));
159            }
160
161            if(toItem != null) {
162                result.setToItem(itemControl.getItemTransfer(userVisit, toItem));
163            }
164
165            result.setRelatedItems(itemControl.getRelatedItemTransfers(userVisit, entities));
166        }
167
168        return result;
169    }
170
171}