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