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.FreeOnBoardDescriptionEdit;
021import com.echothree.control.user.shipment.common.form.EditFreeOnBoardDescriptionForm;
022import com.echothree.control.user.shipment.common.result.ShipmentResultFactory;
023import com.echothree.control.user.shipment.common.spec.FreeOnBoardDescriptionSpec;
024import com.echothree.model.control.shipment.server.control.FreeOnBoardControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseEditCommand;
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 EditFreeOnBoardDescriptionCommand
045        extends BaseEditCommand<FreeOnBoardDescriptionSpec, FreeOnBoardDescriptionEdit> {
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.Description.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062        );
063        
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
066        );
067    }
068
069    @Inject
070    FreeOnBoardControl freeOnBoardControl;
071
072    @Inject
073    PartyControl partyControl;
074
075    
076    /** Creates a new instance of EditFreeOnBoardDescriptionCommand */
077    public EditFreeOnBoardDescriptionCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    protected BaseResult execute() {
083        var result = ShipmentResultFactory.getEditFreeOnBoardDescriptionResult();
084        var freeOnBoardName = spec.getFreeOnBoardName();
085        var freeOnBoard = freeOnBoardControl.getFreeOnBoardByName(freeOnBoardName);
086        
087        if(freeOnBoard != null) {
088            var languageIsoName = spec.getLanguageIsoName();
089            var language = partyControl.getLanguageByIsoName(languageIsoName);
090            
091            if(language != null) {
092                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093                    var freeOnBoardDescription = freeOnBoardControl.getFreeOnBoardDescription(freeOnBoard, language);
094                    
095                    if(freeOnBoardDescription != null) {
096                        if(editMode.equals(EditMode.LOCK)) {
097                            result.setFreeOnBoardDescription(freeOnBoardControl.getFreeOnBoardDescriptionTransfer(getUserVisit(), freeOnBoardDescription));
098
099                            if(lockEntity(freeOnBoard)) {
100                                var edit = ShipmentEditFactory.getFreeOnBoardDescriptionEdit();
101
102                                result.setEdit(edit);
103                                edit.setDescription(freeOnBoardDescription.getDescription());
104                            } else {
105                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
106                            }
107
108                            result.setEntityLock(getEntityLockTransfer(freeOnBoard));
109                        } else { // EditMode.ABANDON
110                            unlockEntity(freeOnBoard);
111                        }
112                    } else {
113                        addExecutionError(ExecutionErrors.UnknownFreeOnBoardDescription.name());
114                    }
115                } else if(editMode.equals(EditMode.UPDATE)) {
116                    var freeOnBoardDescriptionValue = freeOnBoardControl.getFreeOnBoardDescriptionValueForUpdate(freeOnBoard, language);
117                    
118                    if(freeOnBoardDescriptionValue != null) {
119                        if(lockEntityForUpdate(freeOnBoard)) {
120                            try {
121                                var description = edit.getDescription();
122                                
123                                freeOnBoardDescriptionValue.setDescription(description);
124                                
125                                freeOnBoardControl.updateFreeOnBoardDescriptionFromValue(freeOnBoardDescriptionValue, getPartyPK());
126                            } finally {
127                                unlockEntity(freeOnBoard);
128                            }
129                        } else {
130                            addExecutionError(ExecutionErrors.EntityLockStale.name());
131                        }
132                    } else {
133                        addExecutionError(ExecutionErrors.UnknownFreeOnBoardDescription.name());
134                    }
135                }
136            } else {
137                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
138            }
139        } else {
140            addExecutionError(ExecutionErrors.UnknownFreeOnBoardName.name(), freeOnBoardName);
141        }
142        
143        return result;
144    }
145    
146}