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.SetDefaultFreeOnBoardForm;
020import com.echothree.model.control.shipment.server.control.FreeOnBoardControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.shipment.server.value.FreeOnBoardDetailValue;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038
039public class SetDefaultFreeOnBoardCommand
040        extends BaseSimpleCommand<SetDefaultFreeOnBoardForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
048                    new SecurityRoleDefinition(SecurityRoleGroups.FreeOnBoard.name(), SecurityRoles.Edit.name())
049                    )))
050                )));
051        
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, true, null, null)
054                ));
055    }
056    
057    /** Creates a new instance of SetDefaultFreeOnBoardCommand */
058    public SetDefaultFreeOnBoardCommand(UserVisitPK userVisitPK, SetDefaultFreeOnBoardForm form) {
059        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
060    }
061    
062    @Override
063    protected BaseResult execute() {
064        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
065        String freeOnBoardName = form.getFreeOnBoardName();
066        FreeOnBoardDetailValue freeOnBoardDetailValue = freeOnBoardControl.getFreeOnBoardDetailValueByNameForUpdate(freeOnBoardName);
067        
068        if(freeOnBoardDetailValue != null) {
069            freeOnBoardDetailValue.setIsDefault(Boolean.TRUE);
070            freeOnBoardControl.updateFreeOnBoardFromValue(freeOnBoardDetailValue, getPartyPK());
071        } else {
072            addExecutionError(ExecutionErrors.UnknownFreeOnBoardName.name(), freeOnBoardName);
073        }
074        
075        return null;
076    }
077    
078}