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 com.echothree.util.server.persistence.Session;
040import java.util.List;
041import javax.enterprise.context.Dependent;
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    /** Creates a new instance of EditFreeOnBoardCommand */
074    public EditFreeOnBoardCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077    
078    @Override
079    public EditFreeOnBoardResult getResult() {
080        return ShipmentResultFactory.getEditFreeOnBoardResult();
081    }
082    
083    @Override
084    public FreeOnBoardEdit getEdit() {
085        return ShipmentEditFactory.getFreeOnBoardEdit();
086    }
087    
088    @Override
089    public FreeOnBoard getEntity(EditFreeOnBoardResult result) {
090        return FreeOnBoardLogic.getInstance().getFreeOnBoardByUniversalSpec(this, spec, false, editModeToEntityPermission(editMode));
091    }
092    
093    @Override
094    public FreeOnBoard getLockEntity(FreeOnBoard freeOnBoard) {
095        return freeOnBoard;
096    }
097    
098    @Override
099    public void fillInResult(EditFreeOnBoardResult result, FreeOnBoard freeOnBoard) {
100        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
101        
102        result.setFreeOnBoard(freeOnBoardControl.getFreeOnBoardTransfer(getUserVisit(), freeOnBoard));
103    }
104    
105    @Override
106    public void doLock(FreeOnBoardEdit edit, FreeOnBoard freeOnBoard) {
107        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
108        var freeOnBoardDescription = freeOnBoardControl.getFreeOnBoardDescription(freeOnBoard, getPreferredLanguage());
109        var freeOnBoardDetail = freeOnBoard.getLastDetail();
110        
111        edit.setFreeOnBoardName(freeOnBoardDetail.getFreeOnBoardName());
112        edit.setIsDefault(freeOnBoardDetail.getIsDefault().toString());
113        edit.setSortOrder(freeOnBoardDetail.getSortOrder().toString());
114
115        if(freeOnBoardDescription != null) {
116            edit.setDescription(freeOnBoardDescription.getDescription());
117        }
118    }
119        
120    @Override
121    public void canUpdate(FreeOnBoard freeOnBoard) {
122        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
123        var freeOnBoardName = edit.getFreeOnBoardName();
124        var duplicateFreeOnBoard = freeOnBoardControl.getFreeOnBoardByName(freeOnBoardName);
125
126        if(duplicateFreeOnBoard != null && !freeOnBoard.equals(duplicateFreeOnBoard)) {
127            addExecutionError(ExecutionErrors.DuplicateFreeOnBoardName.name(), freeOnBoardName);
128        }
129    }
130    
131    @Override
132    public void doUpdate(FreeOnBoard freeOnBoard) {
133        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
134        var partyPK = getPartyPK();
135        var freeOnBoardDetailValue = freeOnBoardControl.getFreeOnBoardDetailValueForUpdate(freeOnBoard);
136        var freeOnBoardDescription = freeOnBoardControl.getFreeOnBoardDescriptionForUpdate(freeOnBoard, getPreferredLanguage());
137        var description = edit.getDescription();
138
139        freeOnBoardDetailValue.setFreeOnBoardName(edit.getFreeOnBoardName());
140        freeOnBoardDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
141        freeOnBoardDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
142
143        freeOnBoardControl.updateFreeOnBoardFromValue(freeOnBoardDetailValue, partyPK);
144
145        if(freeOnBoardDescription == null && description != null) {
146            freeOnBoardControl.createFreeOnBoardDescription(freeOnBoard, getPreferredLanguage(), description, partyPK);
147        } else if(freeOnBoardDescription != null && description == null) {
148            freeOnBoardControl.deleteFreeOnBoardDescription(freeOnBoardDescription, partyPK);
149        } else if(freeOnBoardDescription != null && description != null) {
150            var freeOnBoardDescriptionValue = freeOnBoardControl.getFreeOnBoardDescriptionValue(freeOnBoardDescription);
151
152            freeOnBoardDescriptionValue.setDescription(description);
153            freeOnBoardControl.updateFreeOnBoardDescriptionFromValue(freeOnBoardDescriptionValue, partyPK);
154        }
155    }
156    
157}