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.CreateRelatedItemForm;
020import com.echothree.control.user.item.common.result.ItemResultFactory;
021import com.echothree.model.control.item.server.control.ItemControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
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.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class CreateRelatedItemCommand
042        extends BaseSimpleCommand<CreateRelatedItemForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.RelatedItem.name(), SecurityRoles.Create.name())
052                )))
053        )));
054
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056            new FieldDefinition("RelatedItemTypeName", FieldType.ENTITY_NAME, true, null, null),
057            new FieldDefinition("FromItemName", FieldType.ENTITY_NAME, true, null, null),
058            new FieldDefinition("ToItemName", FieldType.ENTITY_NAME, true, null, null),
059            new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
060        ));
061    }
062    
063    /** Creates a new instance of CreateRelatedItemCommand */
064    public CreateRelatedItemCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var result = ItemResultFactory.getCreateRelatedItemResult();
071        var itemControl = Session.getModelController(ItemControl.class);
072        var relatedItemTypeName = form.getRelatedItemTypeName();
073        var relatedItemType = itemControl.getRelatedItemTypeByName(relatedItemTypeName);
074        
075        if(relatedItemType != null) {
076            var fromItemName = form.getFromItemName();
077            var fromItem = itemControl.getItemByName(fromItemName);
078            
079            if(fromItem != null) {
080                var toItemName = form.getToItemName();
081                var toItem = itemControl.getItemByName(toItemName);
082                
083                if(toItem != null) {
084                    if(!fromItem.equals(toItem)) {
085                        var relatedItem = itemControl.getRelatedItem(relatedItemType, fromItem, toItem);
086
087                        if(relatedItem == null) {
088                            var sortOrder = Integer.valueOf(form.getSortOrder());
089
090                            itemControl.createRelatedItem(relatedItemType, fromItem, toItem, sortOrder, getPartyPK());
091
092                            result.setRelatedItemTypeName(relatedItemType.getLastDetail().getRelatedItemTypeName());
093                            result.setFromItemName(fromItem.getLastDetail().getItemName());
094                            result.setToItemName(toItem.getLastDetail().getItemName());
095                            result.setEntityRef(relatedItemType.getPrimaryKey().getEntityRef());
096                        } else {
097                            addExecutionError(ExecutionErrors.DuplicateRelatedItem.name(),
098                                    relatedItemType.getLastDetail().getRelatedItemTypeName(),
099                                    fromItem.getLastDetail().getItemName(), toItem.getLastDetail().getItemName());
100                        }
101                    } else {
102                        addExecutionError(ExecutionErrors.CannotRelateToSelf.name(),
103                                fromItem.getLastDetail().getItemName(), toItem.getLastDetail().getItemName());
104                    }
105                } else {
106                    addExecutionError(ExecutionErrors.UnknownToItemName.name(), toItemName);
107                }
108            } else {
109                addExecutionError(ExecutionErrors.UnknownFromItemName.name(), fromItemName);
110            }
111        } else {
112            addExecutionError(ExecutionErrors.UnknownRelatedItemTypeName.name(), relatedItemTypeName);
113        }
114
115        return result;
116    }
117    
118}