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.shipment.server.command;
018
019import com.echothree.control.user.shipment.common.edit.ShipmentEditFactory;
020import com.echothree.control.user.shipment.common.edit.FreeOnBoardEdit;
021import com.echothree.control.user.shipment.common.form.EditFreeOnBoardForm;
022import com.echothree.control.user.shipment.common.result.ShipmentResultFactory;
023import com.echothree.control.user.shipment.common.result.EditFreeOnBoardResult;
024import com.echothree.control.user.shipment.common.spec.FreeOnBoardUniversalSpec;
025import com.echothree.model.control.shipment.server.control.FreeOnBoardControl;
026import com.echothree.model.control.shipment.server.logic.FreeOnBoardLogic;
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.shipment.server.entity.FreeOnBoard;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditFreeOnBoardCommand
045        extends BaseAbstractEditCommand<FreeOnBoardUniversalSpec, FreeOnBoardEdit, EditFreeOnBoardResult, FreeOnBoard, FreeOnBoard> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.FreeOnBoard.name(), SecurityRoles.Edit.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
062                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
063        );
064        
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, 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    FreeOnBoardControl freeOnBoardControl;
075
076    @Inject
077    FreeOnBoardLogic freeOnBoardLogic;
078
079    
080    /** Creates a new instance of EditFreeOnBoardCommand */
081    public EditFreeOnBoardCommand() {
082        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084    
085    @Override
086    public EditFreeOnBoardResult getResult() {
087        return ShipmentResultFactory.getEditFreeOnBoardResult();
088    }
089    
090    @Override
091    public FreeOnBoardEdit getEdit() {
092        return ShipmentEditFactory.getFreeOnBoardEdit();
093    }
094    
095    @Override
096    public FreeOnBoard getEntity(EditFreeOnBoardResult result) {
097        return freeOnBoardLogic.getFreeOnBoardByUniversalSpec(this, spec, false, editModeToEntityPermission(editMode));
098    }
099    
100    @Override
101    public FreeOnBoard getLockEntity(FreeOnBoard freeOnBoard) {
102        return freeOnBoard;
103    }
104    
105    @Override
106    public void fillInResult(EditFreeOnBoardResult result, FreeOnBoard freeOnBoard) {
107        result.setFreeOnBoard(freeOnBoardControl.getFreeOnBoardTransfer(getUserVisit(), freeOnBoard));
108    }
109    
110    @Override
111    public void doLock(FreeOnBoardEdit edit, FreeOnBoard freeOnBoard) {
112        var freeOnBoardDescription = freeOnBoardControl.getFreeOnBoardDescription(freeOnBoard, getPreferredLanguage());
113        var freeOnBoardDetail = freeOnBoard.getLastDetail();
114        
115        edit.setFreeOnBoardName(freeOnBoardDetail.getFreeOnBoardName());
116        edit.setIsDefault(freeOnBoardDetail.getIsDefault().toString());
117        edit.setSortOrder(freeOnBoardDetail.getSortOrder().toString());
118
119        if(freeOnBoardDescription != null) {
120            edit.setDescription(freeOnBoardDescription.getDescription());
121        }
122    }
123        
124    @Override
125    public void canUpdate(FreeOnBoard freeOnBoard) {
126        var freeOnBoardName = edit.getFreeOnBoardName();
127        var duplicateFreeOnBoard = freeOnBoardControl.getFreeOnBoardByName(freeOnBoardName);
128
129        if(duplicateFreeOnBoard != null && !freeOnBoard.equals(duplicateFreeOnBoard)) {
130            addExecutionError(ExecutionErrors.DuplicateFreeOnBoardName.name(), freeOnBoardName);
131        }
132    }
133    
134    @Override
135    public void doUpdate(FreeOnBoard freeOnBoard) {
136        var partyPK = getPartyPK();
137        var freeOnBoardDetailValue = freeOnBoardControl.getFreeOnBoardDetailValueForUpdate(freeOnBoard);
138        var freeOnBoardDescription = freeOnBoardControl.getFreeOnBoardDescriptionForUpdate(freeOnBoard, getPreferredLanguage());
139        var description = edit.getDescription();
140
141        freeOnBoardDetailValue.setFreeOnBoardName(edit.getFreeOnBoardName());
142        freeOnBoardDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
143        freeOnBoardDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
144
145        freeOnBoardControl.updateFreeOnBoardFromValue(freeOnBoardDetailValue, partyPK);
146
147        if(freeOnBoardDescription == null && description != null) {
148            freeOnBoardControl.createFreeOnBoardDescription(freeOnBoard, getPreferredLanguage(), description, partyPK);
149        } else if(freeOnBoardDescription != null && description == null) {
150            freeOnBoardControl.deleteFreeOnBoardDescription(freeOnBoardDescription, partyPK);
151        } else if(freeOnBoardDescription != null && description != null) {
152            var freeOnBoardDescriptionValue = freeOnBoardControl.getFreeOnBoardDescriptionValue(freeOnBoardDescription);
153
154            freeOnBoardDescriptionValue.setDescription(description);
155            freeOnBoardControl.updateFreeOnBoardDescriptionFromValue(freeOnBoardDescriptionValue, partyPK);
156        }
157    }
158    
159}