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.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.shipment.server.entity.FreeOnBoardDescription;
032import com.echothree.model.data.shipment.server.entity.FreeOnBoardDetail;
033import com.echothree.model.data.shipment.server.value.FreeOnBoardDescriptionValue;
034import com.echothree.model.data.shipment.server.value.FreeOnBoardDetailValue;
035import com.echothree.model.data.party.common.pk.PartyPK;
036import com.echothree.model.data.user.common.pk.UserVisitPK;
037import com.echothree.util.common.message.ExecutionErrors;
038import com.echothree.util.common.validation.FieldDefinition;
039import com.echothree.util.common.validation.FieldType;
040import com.echothree.util.server.control.BaseAbstractEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.Arrays;
046import java.util.Collections;
047import java.util.List;
048
049public class EditFreeOnBoardCommand
050        extends BaseAbstractEditCommand<FreeOnBoardUniversalSpec, FreeOnBoardEdit, EditFreeOnBoardResult, FreeOnBoard, FreeOnBoard> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                        new SecurityRoleDefinition(SecurityRoleGroups.FreeOnBoard.name(), SecurityRoles.Edit.name())
061                        )))
062                )));
063        
064        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
067                new FieldDefinition("Key", FieldType.KEY, false, null, null),
068                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
069                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
070                ));
071        
072        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
073                new FieldDefinition("FreeOnBoardName", FieldType.ENTITY_NAME, true, null, null),
074                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
075                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
076                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
077                ));
078    }
079    
080    /** Creates a new instance of EditFreeOnBoardCommand */
081    public EditFreeOnBoardCommand(UserVisitPK userVisitPK, EditFreeOnBoardForm form) {
082        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084    
085    @Override
086    public EditFreeOnBoardResult getResult() {
087        return ShipmentResultFactory.getEditFreeOnBoardResult();
088    }
089    
090    @Override
091    public FreeOnBoardEdit getEdit() {
092        return ShipmentEditFactory.getFreeOnBoardEdit();
093    }
094    
095    @Override
096    public FreeOnBoard getEntity(EditFreeOnBoardResult result) {
097        return FreeOnBoardLogic.getInstance().getFreeOnBoardByUniversalSpec(this, spec, false, editModeToEntityPermission(editMode));
098    }
099    
100    @Override
101    public FreeOnBoard getLockEntity(FreeOnBoard freeOnBoard) {
102        return freeOnBoard;
103    }
104    
105    @Override
106    public void fillInResult(EditFreeOnBoardResult result, FreeOnBoard freeOnBoard) {
107        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
108        
109        result.setFreeOnBoard(freeOnBoardControl.getFreeOnBoardTransfer(getUserVisit(), freeOnBoard));
110    }
111    
112    @Override
113    public void doLock(FreeOnBoardEdit edit, FreeOnBoard freeOnBoard) {
114        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
115        FreeOnBoardDescription freeOnBoardDescription = freeOnBoardControl.getFreeOnBoardDescription(freeOnBoard, getPreferredLanguage());
116        FreeOnBoardDetail freeOnBoardDetail = freeOnBoard.getLastDetail();
117        
118        edit.setFreeOnBoardName(freeOnBoardDetail.getFreeOnBoardName());
119        edit.setIsDefault(freeOnBoardDetail.getIsDefault().toString());
120        edit.setSortOrder(freeOnBoardDetail.getSortOrder().toString());
121
122        if(freeOnBoardDescription != null) {
123            edit.setDescription(freeOnBoardDescription.getDescription());
124        }
125    }
126        
127    @Override
128    public void canUpdate(FreeOnBoard freeOnBoard) {
129        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
130        String freeOnBoardName = edit.getFreeOnBoardName();
131        FreeOnBoard duplicateFreeOnBoard = freeOnBoardControl.getFreeOnBoardByName(freeOnBoardName);
132
133        if(duplicateFreeOnBoard != null && !freeOnBoard.equals(duplicateFreeOnBoard)) {
134            addExecutionError(ExecutionErrors.DuplicateFreeOnBoardName.name(), freeOnBoardName);
135        }
136    }
137    
138    @Override
139    public void doUpdate(FreeOnBoard freeOnBoard) {
140        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
141        var partyPK = getPartyPK();
142        FreeOnBoardDetailValue freeOnBoardDetailValue = freeOnBoardControl.getFreeOnBoardDetailValueForUpdate(freeOnBoard);
143        FreeOnBoardDescription freeOnBoardDescription = freeOnBoardControl.getFreeOnBoardDescriptionForUpdate(freeOnBoard, getPreferredLanguage());
144        String description = edit.getDescription();
145
146        freeOnBoardDetailValue.setFreeOnBoardName(edit.getFreeOnBoardName());
147        freeOnBoardDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
148        freeOnBoardDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
149
150        freeOnBoardControl.updateFreeOnBoardFromValue(freeOnBoardDetailValue, partyPK);
151
152        if(freeOnBoardDescription == null && description != null) {
153            freeOnBoardControl.createFreeOnBoardDescription(freeOnBoard, getPreferredLanguage(), description, partyPK);
154        } else if(freeOnBoardDescription != null && description == null) {
155            freeOnBoardControl.deleteFreeOnBoardDescription(freeOnBoardDescription, partyPK);
156        } else if(freeOnBoardDescription != null && description != null) {
157            FreeOnBoardDescriptionValue freeOnBoardDescriptionValue = freeOnBoardControl.getFreeOnBoardDescriptionValue(freeOnBoardDescription);
158
159            freeOnBoardDescriptionValue.setDescription(description);
160            freeOnBoardControl.updateFreeOnBoardDescriptionFromValue(freeOnBoardDescriptionValue, partyPK);
161        }
162    }
163    
164}