001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.form.DeleteFreeOnBoardDescriptionForm;
020import com.echothree.model.control.shipment.server.control.FreeOnBoardControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.shipment.server.entity.FreeOnBoard;
026import com.echothree.model.data.shipment.server.entity.FreeOnBoardDescription;
027import com.echothree.model.data.party.server.entity.Language;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class DeleteFreeOnBoardDescriptionCommand
043        extends BaseSimpleCommand<DeleteFreeOnBoardDescriptionForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.FreeOnBoard.name(), SecurityRoles.Description.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of DeleteFreeOnBoardDescriptionCommand */
063    public DeleteFreeOnBoardDescriptionCommand(UserVisitPK userVisitPK, DeleteFreeOnBoardDescriptionForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
070        String freeOnBoardName = form.getFreeOnBoardName();
071        FreeOnBoard freeOnBoard = freeOnBoardControl.getFreeOnBoardByName(freeOnBoardName);
072        
073        if(freeOnBoard != null) {
074            var partyControl = Session.getModelController(PartyControl.class);
075            String languageIsoName = form.getLanguageIsoName();
076            Language language = partyControl.getLanguageByIsoName(languageIsoName);
077            
078            if(language != null) {
079                FreeOnBoardDescription freeOnBoardDescription = freeOnBoardControl.getFreeOnBoardDescriptionForUpdate(freeOnBoard, language);
080                
081                if(freeOnBoardDescription != null) {
082                    freeOnBoardControl.deleteFreeOnBoardDescription(freeOnBoardDescription, getPartyPK());
083                } else {
084                    addExecutionError(ExecutionErrors.UnknownFreeOnBoardDescription.name());
085                }
086            } else {
087                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
088            }
089        } else {
090            addExecutionError(ExecutionErrors.UnknownFreeOnBoardName.name(), freeOnBoardName);
091        }
092        
093        return null;
094    }
095    
096}