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.offer.server.logic;
018
019import com.echothree.control.user.offer.common.spec.UseNameElementDescriptionSpec;
020import com.echothree.control.user.offer.common.spec.UseNameElementUniversalSpec;
021import com.echothree.model.control.core.common.ComponentVendors;
022import com.echothree.model.control.core.common.EntityTypes;
023import com.echothree.model.control.core.common.exception.InvalidParameterCountException;
024import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
025import com.echothree.model.control.offer.common.exception.DuplicateUseNameElementNameException;
026import com.echothree.model.control.offer.common.exception.UnknownUseNameElementDescriptionException;
027import com.echothree.model.control.offer.common.exception.UnknownUseNameElementNameException;
028import com.echothree.model.control.offer.server.control.UseNameElementControl;
029import com.echothree.model.control.party.server.logic.LanguageLogic;
030import com.echothree.model.data.offer.server.entity.UseNameElement;
031import com.echothree.model.data.offer.server.entity.UseNameElementDescription;
032import com.echothree.model.data.party.server.entity.Language;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.persistence.BasePK;
035import com.echothree.util.server.control.BaseLogic;
036import com.echothree.util.server.message.ExecutionErrorAccumulator;
037import com.echothree.util.server.persistence.EntityPermission;
038import javax.enterprise.context.ApplicationScoped;
039import javax.inject.Inject;
040
041@ApplicationScoped
042public class UseNameElementLogic
043        extends BaseLogic {
044
045    @Inject
046    UseNameElementControl useNameElementControl;
047
048    @Inject
049    EntityInstanceLogic entityInstanceLogic;
050
051    @Inject
052    LanguageLogic languageLogic;
053
054    protected UseNameElementLogic() {
055        super();
056    }
057
058    public UseNameElement createUseNameElement(final ExecutionErrorAccumulator eea, final String useNameElementName,
059            final Integer offset, final Integer length, final String validationPattern, final Language language, final String description,
060            final BasePK createdBy) {
061        var useNameElement = useNameElementControl.getUseNameElementByName(useNameElementName);
062
063        if(useNameElement == null) {
064            useNameElement = useNameElementControl.createUseNameElement(useNameElementName, offset, length, validationPattern,
065                    createdBy);
066
067            if(description != null) {
068                useNameElementControl.createUseNameElementDescription(useNameElement, language, description, createdBy);
069            }
070        } else {
071            handleExecutionError(DuplicateUseNameElementNameException.class, eea, ExecutionErrors.DuplicateUseNameElementName.name(),
072                    useNameElementName);
073        }
074
075        return useNameElement;
076    }
077
078    public UseNameElement getUseNameElementByName(final ExecutionErrorAccumulator eea, final String useNameElementName,
079            final EntityPermission entityPermission) {
080        var useNameElement = useNameElementControl.getUseNameElementByName(useNameElementName, entityPermission);
081
082        if(useNameElement == null) {
083            handleExecutionError(UnknownUseNameElementNameException.class, eea, ExecutionErrors.UnknownUseNameElementName.name(), useNameElementName);
084        }
085
086        return useNameElement;
087    }
088
089    public UseNameElement getUseNameElementByName(final ExecutionErrorAccumulator eea, final String useNameElementName) {
090        return getUseNameElementByName(eea, useNameElementName, EntityPermission.READ_ONLY);
091    }
092
093    public UseNameElement getUseNameElementByNameForUpdate(final ExecutionErrorAccumulator eea, final String useNameElementName) {
094        return getUseNameElementByName(eea, useNameElementName, EntityPermission.READ_WRITE);
095    }
096
097    public UseNameElement getUseNameElementByUniversalSpec(final ExecutionErrorAccumulator eea,
098            final UseNameElementUniversalSpec universalSpec, final EntityPermission entityPermission) {
099        var useNameElementName = universalSpec.getUseNameElementName();
100        var parameterCount = (useNameElementName == null ? 0 : 1) + entityInstanceLogic.countPossibleEntitySpecs(universalSpec);
101        UseNameElement useNameElement = null;
102
103        if(parameterCount == 1) {
104            if(useNameElementName == null) {
105                var entityInstance = entityInstanceLogic.getEntityInstance(eea, universalSpec,
106                        ComponentVendors.ECHO_THREE.name(), EntityTypes.UseNameElement.name());
107
108                if(eea == null || !eea.hasExecutionErrors()) {
109                    useNameElement = useNameElementControl.getUseNameElementByEntityInstance(entityInstance, entityPermission);
110                }
111            } else {
112                useNameElement = getUseNameElementByName(eea, useNameElementName, entityPermission);
113            }
114        } else {
115            handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
116        }
117
118        return useNameElement;
119    }
120
121    public UseNameElement getUseNameElementByUniversalSpec(final ExecutionErrorAccumulator eea,
122            final UseNameElementUniversalSpec universalSpec) {
123        return getUseNameElementByUniversalSpec(eea, universalSpec, EntityPermission.READ_ONLY);
124    }
125
126    public UseNameElement getUseNameElementByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
127            final UseNameElementUniversalSpec universalSpec) {
128        return getUseNameElementByUniversalSpec(eea, universalSpec, EntityPermission.READ_WRITE);
129    }
130
131    public UseNameElementDescription getUseNameElementDescriptionBySpec(final ExecutionErrorAccumulator eea,
132            final UseNameElementDescriptionSpec spec, final EntityPermission entityPermission) {
133        UseNameElementDescription useNameElementDescription = null;
134        var useNameElementName = spec.getUseNameElementName();
135        var useNameElement = getUseNameElementByName(eea, useNameElementName);
136
137        if(!hasExecutionErrors(eea)) {
138            var languageIsoName = spec.getLanguageIsoName();
139            var language = languageLogic.getLanguageByName(eea, languageIsoName);
140
141            if(!hasExecutionErrors(eea)) {
142                useNameElementDescription = useNameElementControl.getUseNameElementDescription(useNameElement, language,
143                        entityPermission);
144
145                if(useNameElementDescription == null) {
146                    handleExecutionError(UnknownUseNameElementDescriptionException.class, eea, ExecutionErrors.UnknownUseNameElementDescription.name(), useNameElementName, languageIsoName);
147                }
148            }
149        }
150
151        return useNameElementDescription;
152    }
153
154    public void deleteUseNameElement(final ExecutionErrorAccumulator eea, final UseNameElement useNameElement,
155            final BasePK deletedBy) {
156        useNameElementControl.deleteUseNameElement(useNameElement, deletedBy);
157    }
158
159}