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.model.control.shipment.server.logic;
018
019import com.echothree.control.user.shipment.common.spec.FreeOnBoardUniversalSpec;
020import com.echothree.model.control.core.common.ComponentVendors;
021import com.echothree.model.control.core.common.EntityTypes;
022import com.echothree.model.control.core.common.exception.InvalidParameterCountException;
023import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
024import com.echothree.model.control.shipment.common.exception.DuplicateFreeOnBoardNameException;
025import com.echothree.model.control.shipment.common.exception.UnknownDefaultFreeOnBoardException;
026import com.echothree.model.control.shipment.common.exception.UnknownFreeOnBoardNameException;
027import com.echothree.model.control.shipment.server.control.FreeOnBoardControl;
028import com.echothree.model.data.party.server.entity.Language;
029import com.echothree.model.data.shipment.server.entity.FreeOnBoard;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.persistence.BasePK;
032import com.echothree.util.server.control.BaseLogic;
033import com.echothree.util.server.message.ExecutionErrorAccumulator;
034import com.echothree.util.server.persistence.EntityPermission;
035import javax.enterprise.context.ApplicationScoped;
036import javax.enterprise.inject.spi.CDI;
037import javax.inject.Inject;
038
039@ApplicationScoped
040public class FreeOnBoardLogic
041        extends BaseLogic {
042
043    @Inject
044    FreeOnBoardControl freeOnBoardControl;
045
046    @Inject
047    EntityInstanceLogic entityInstanceLogic;
048
049    protected FreeOnBoardLogic() {
050        super();
051    }
052
053    public static FreeOnBoardLogic getInstance() {
054        return CDI.current().select(FreeOnBoardLogic.class).get();
055    }
056
057    public FreeOnBoard createFreeOnBoard(final ExecutionErrorAccumulator eea, final String freeOnBoardName,
058            final Boolean isDefault, final Integer sortOrder, final Language language, final String description,
059            final BasePK createdBy) {
060        var freeOnBoard = freeOnBoardControl.getFreeOnBoardByName(freeOnBoardName);
061
062        if(freeOnBoard == null) {
063            freeOnBoard = freeOnBoardControl.createFreeOnBoard(freeOnBoardName, isDefault, sortOrder, createdBy);
064
065            if(description != null) {
066                freeOnBoardControl.createFreeOnBoardDescription(freeOnBoard, language, description, createdBy);
067            }
068        } else {
069            handleExecutionError(DuplicateFreeOnBoardNameException.class, eea, ExecutionErrors.DuplicateFreeOnBoardName.name(), freeOnBoardName);
070        }
071
072        return freeOnBoard;
073    }
074
075    public FreeOnBoard getFreeOnBoardByName(final ExecutionErrorAccumulator eea, final String freeOnBoardName,
076            final EntityPermission entityPermission) {
077        var freeOnBoard = freeOnBoardControl.getFreeOnBoardByName(freeOnBoardName, entityPermission);
078
079        if(freeOnBoard == null) {
080            handleExecutionError(UnknownFreeOnBoardNameException.class, eea, ExecutionErrors.UnknownFreeOnBoardName.name(), freeOnBoardName);
081        }
082
083        return freeOnBoard;
084    }
085
086    public FreeOnBoard getFreeOnBoardByName(final ExecutionErrorAccumulator eea, final String freeOnBoardName) {
087        return getFreeOnBoardByName(eea, freeOnBoardName, EntityPermission.READ_ONLY);
088    }
089
090    public FreeOnBoard getFreeOnBoardByNameForUpdate(final ExecutionErrorAccumulator eea, final String freeOnBoardName) {
091        return getFreeOnBoardByName(eea, freeOnBoardName, EntityPermission.READ_WRITE);
092    }
093
094    public FreeOnBoard getFreeOnBoardByUniversalSpec(final ExecutionErrorAccumulator eea,
095            final FreeOnBoardUniversalSpec universalSpec, boolean allowDefault, final EntityPermission entityPermission) {
096        FreeOnBoard freeOnBoard = null;
097        var freeOnBoardName = universalSpec.getFreeOnBoardName();
098        var parameterCount = (freeOnBoardName == null ? 0 : 1) + entityInstanceLogic.countPossibleEntitySpecs(universalSpec);
099
100        switch(parameterCount) {
101            case 0 -> {
102                if(allowDefault) {
103                    freeOnBoard = freeOnBoardControl.getDefaultFreeOnBoard(entityPermission);
104
105                    if(freeOnBoard == null) {
106                        handleExecutionError(UnknownDefaultFreeOnBoardException.class, eea, ExecutionErrors.UnknownDefaultFreeOnBoard.name());
107                    }
108                } else {
109                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
110                }
111            }
112            case 1 -> {
113                if(freeOnBoardName == null) {
114                    var entityInstance = entityInstanceLogic.getEntityInstance(eea, universalSpec,
115                            ComponentVendors.ECHO_THREE.name(), EntityTypes.FreeOnBoard.name());
116
117                    if(eea == null || !eea.hasExecutionErrors()) {
118                        freeOnBoard = freeOnBoardControl.getFreeOnBoardByEntityInstance(entityInstance, entityPermission);
119                    }
120                } else {
121                    freeOnBoard = getFreeOnBoardByName(eea, freeOnBoardName, entityPermission);
122                }
123            }
124            default ->
125                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
126        }
127
128        return freeOnBoard;
129    }
130
131    public FreeOnBoard getFreeOnBoardByUniversalSpec(final ExecutionErrorAccumulator eea,
132            final FreeOnBoardUniversalSpec universalSpec, boolean allowDefault) {
133        return getFreeOnBoardByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
134    }
135
136    public FreeOnBoard getFreeOnBoardByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
137            final FreeOnBoardUniversalSpec universalSpec, boolean allowDefault) {
138        return getFreeOnBoardByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
139    }
140
141    public FreeOnBoard getDefaultFreeOnBoard(final ExecutionErrorAccumulator eea) {
142        var freeOnBoard = freeOnBoardControl.getDefaultFreeOnBoard();
143
144        if(freeOnBoard == null) {
145            handleExecutionError(UnknownDefaultFreeOnBoardException.class, eea, ExecutionErrors.UnknownDefaultFreeOnBoard.name());
146        }
147
148        return freeOnBoard;
149    }
150
151    public void deleteFreeOnBoard(final ExecutionErrorAccumulator eea, final FreeOnBoard freeOnBoard,
152            final BasePK deletedBy) {
153        freeOnBoardControl.deleteFreeOnBoard(freeOnBoard, deletedBy);
154    }
155}