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.form.CreateFreeOnBoardForm;
020import com.echothree.control.user.shipment.common.result.ShipmentResultFactory;
021import com.echothree.model.control.shipment.server.logic.FreeOnBoardLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import java.util.List;
034import javax.enterprise.context.Dependent;
035import javax.inject.Inject;
036
037@Dependent
038public class CreateFreeOnBoardCommand
039        extends BaseSimpleCommand<CreateFreeOnBoardForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.FreeOnBoard.name(), SecurityRoles.Create.name())
049                ))
050        ));
051        
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
055                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
056                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
057        );
058    }
059
060    @Inject
061    FreeOnBoardLogic freeOnBoardLogic;
062
063    
064    /** Creates a new instance of CreateFreeOnBoardCommand */
065    public CreateFreeOnBoardCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var result = ShipmentResultFactory.getCreateFreeOnBoardResult();
072        var freeOnBoardName = form.getFreeOnBoardName();
073        var isDefault = Boolean.valueOf(form.getIsDefault());
074        var sortOrder = Integer.valueOf(form.getSortOrder());
075        var description = form.getDescription();
076
077        var freeOnBoard = freeOnBoardLogic.createFreeOnBoard(this,
078                freeOnBoardName, isDefault, sortOrder, getPreferredLanguage(), description, getPartyPK());
079
080        if(freeOnBoard != null && !hasExecutionErrors()) {
081            result.setFreeOnBoardName(freeOnBoard.getLastDetail().getFreeOnBoardName());
082            result.setEntityRef(freeOnBoard.getPrimaryKey().getEntityRef());
083        }
084
085        return result;
086    }
087    
088}