001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.inventory.server.command;
018
019import com.echothree.control.user.inventory.common.edit.AllocationPriorityEdit;
020import com.echothree.control.user.inventory.common.edit.InventoryEditFactory;
021import com.echothree.control.user.inventory.common.form.EditAllocationPriorityForm;
022import com.echothree.control.user.inventory.common.result.EditAllocationPriorityResult;
023import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
024import com.echothree.control.user.inventory.common.spec.AllocationPriorityUniversalSpec;
025import com.echothree.model.control.inventory.server.control.AllocationPriorityControl;
026import com.echothree.model.control.inventory.server.logic.AllocationPriorityLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.inventory.server.entity.AllocationPriority;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.command.EditMode;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.server.control.BaseAbstractEditCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import java.util.List;
041import javax.inject.Inject;
042import javax.enterprise.context.Dependent;
043
044@Dependent
045public class EditAllocationPriorityCommand
046        extends BaseAbstractEditCommand<AllocationPriorityUniversalSpec, AllocationPriorityEdit, EditAllocationPriorityResult, AllocationPriority, AllocationPriority> {
047
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
050    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
051
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
056                        new SecurityRoleDefinition(SecurityRoleGroups.AllocationPriority.name(), SecurityRoles.Edit.name())
057                ))
058        ));
059
060        SPEC_FIELD_DEFINITIONS = List.of(
061                new FieldDefinition("AllocationPriorityName", FieldType.ENTITY_NAME, true, null, null)
062        );
063
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("AllocationPriorityName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("Priority", FieldType.UNSIGNED_INTEGER, true, null, null),
067                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
068                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
069                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
070        );
071    }
072
073    @Inject
074    AllocationPriorityControl allocationPriorityControl;
075
076    @Inject
077    AllocationPriorityLogic allocationPriorityLogic;
078
079    /** Creates a new instance of EditAllocationPriorityCommand */
080    public EditAllocationPriorityCommand() {
081        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
082    }
083
084    @Override
085    public EditAllocationPriorityResult getResult() {
086        return InventoryResultFactory.getEditAllocationPriorityResult();
087    }
088
089    @Override
090    public AllocationPriorityEdit getEdit() {
091        return InventoryEditFactory.getAllocationPriorityEdit();
092    }
093
094    @Override
095    public AllocationPriority getEntity(EditAllocationPriorityResult result) {
096        AllocationPriority allocationPriority;
097
098        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
099            allocationPriority = allocationPriorityLogic.getAllocationPriorityByUniversalSpec(this, spec, false);
100        } else { // EditMode.UPDATE
101            allocationPriority = allocationPriorityLogic.getAllocationPriorityByUniversalSpecForUpdate(this, spec, false);
102        }
103
104        if(!hasExecutionErrors()) {
105            result.setAllocationPriority(allocationPriorityControl.getAllocationPriorityTransfer(getUserVisit(), allocationPriority));
106        }
107
108        return allocationPriority;
109    }
110
111    @Override
112    public AllocationPriority getLockEntity(AllocationPriority allocationPriority) {
113        return allocationPriority;
114    }
115
116    @Override
117    public void fillInResult(EditAllocationPriorityResult result, AllocationPriority allocationPriority) {
118        result.setAllocationPriority(allocationPriorityControl.getAllocationPriorityTransfer(getUserVisit(), allocationPriority));
119    }
120
121    @Override
122    public void doLock(AllocationPriorityEdit edit, AllocationPriority allocationPriority) {
123        var allocationPriorityDescription = allocationPriorityControl.getAllocationPriorityDescription(allocationPriority, getPreferredLanguage());
124        var allocationPriorityDetail = allocationPriority.getLastDetail();
125
126        edit.setAllocationPriorityName(allocationPriorityDetail.getAllocationPriorityName());
127        edit.setPriority(allocationPriorityDetail.getPriority().toString());
128        edit.setIsDefault(allocationPriorityDetail.getIsDefault().toString());
129        edit.setSortOrder(allocationPriorityDetail.getSortOrder().toString());
130
131        if(allocationPriorityDescription != null) {
132            edit.setDescription(allocationPriorityDescription.getDescription());
133        }
134    }
135
136    @Override
137    public void canUpdate(AllocationPriority allocationPriority) {
138        var allocationPriorityName = edit.getAllocationPriorityName();
139        var duplicateAllocationPriority = allocationPriorityControl.getAllocationPriorityByName(allocationPriorityName);
140
141        if(duplicateAllocationPriority != null && !allocationPriority.equals(duplicateAllocationPriority)) {
142            addExecutionError(ExecutionErrors.DuplicateAllocationPriorityName.name(), allocationPriorityName);
143        }
144    }
145
146    @Override
147    public void doUpdate(AllocationPriority allocationPriority) {
148        var partyPK = getPartyPK();
149        var allocationPriorityDetailValue = allocationPriorityControl.getAllocationPriorityDetailValueForUpdate(allocationPriority);
150        var allocationPriorityDescription = allocationPriorityControl.getAllocationPriorityDescriptionForUpdate(allocationPriority, getPreferredLanguage());
151        var description = edit.getDescription();
152
153        allocationPriorityDetailValue.setAllocationPriorityName(edit.getAllocationPriorityName());
154        allocationPriorityDetailValue.setPriority(Integer.valueOf(edit.getPriority()));
155        allocationPriorityDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
156        allocationPriorityDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
157
158        allocationPriorityLogic.updateAllocationPriorityFromValue(allocationPriorityDetailValue, partyPK);
159
160        if(allocationPriorityDescription == null && description != null) {
161            allocationPriorityControl.createAllocationPriorityDescription(allocationPriority, getPreferredLanguage(), description, partyPK);
162        } else {
163            if(allocationPriorityDescription != null && description == null) {
164                allocationPriorityControl.deleteAllocationPriorityDescription(allocationPriorityDescription, partyPK);
165            } else {
166                if(allocationPriorityDescription != null && description != null) {
167                    var allocationPriorityDescriptionValue = allocationPriorityControl.getAllocationPriorityDescriptionValue(allocationPriorityDescription);
168
169                    allocationPriorityDescriptionValue.setDescription(description);
170                    allocationPriorityControl.updateAllocationPriorityDescriptionFromValue(allocationPriorityDescriptionValue, partyPK);
171                }
172            }
173        }
174    }
175
176}