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.model.control.offer.server.logic;
018
019import com.echothree.control.user.offer.common.spec.UseNameElementUniversalSpec;
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.offer.common.exception.DuplicateUseNameElementNameException;
025import com.echothree.model.control.offer.common.exception.UnknownUseNameElementNameException;
026import com.echothree.model.control.offer.server.control.UseNameElementControl;
027import com.echothree.model.data.core.server.entity.EntityInstance;
028import com.echothree.model.data.offer.server.entity.UseNameElement;
029import com.echothree.model.data.party.server.entity.Language;
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 com.echothree.util.server.persistence.Session;
036
037public class UseNameElementLogic
038        extends BaseLogic {
039
040    private UseNameElementLogic() {
041        super();
042    }
043
044    private static class UseNameElementLogicHolder {
045        static UseNameElementLogic instance = new UseNameElementLogic();
046    }
047
048    public static UseNameElementLogic getInstance() {
049        return UseNameElementLogic.UseNameElementLogicHolder.instance;
050    }
051
052    public UseNameElement createUseNameElement(final ExecutionErrorAccumulator eea, final String useNameElementName,
053            final Integer offset, final Integer length, final String validationPattern, final Language language, final String description,
054            final BasePK createdBy) {
055        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
056        var useNameElement = useNameElementControl.getUseNameElementByName(useNameElementName);
057
058        if(useNameElement == null) {
059            useNameElement = useNameElementControl.createUseNameElement(useNameElementName, offset, length, validationPattern,
060                    createdBy);
061
062            if(description != null) {
063                useNameElementControl.createUseNameElementDescription(useNameElement, language, description, createdBy);
064            }
065        } else {
066            handleExecutionError(DuplicateUseNameElementNameException.class, eea, ExecutionErrors.DuplicateUseNameElementName.name(),
067                    useNameElementName);
068        }
069
070        return useNameElement;
071    }
072
073    public UseNameElement getUseNameElementByName(final ExecutionErrorAccumulator eea, final String useNameElementName,
074            final EntityPermission entityPermission) {
075        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
076        var useNameElement = useNameElementControl.getUseNameElementByName(useNameElementName, entityPermission);
077
078        if(useNameElement == null) {
079            handleExecutionError(UnknownUseNameElementNameException.class, eea, ExecutionErrors.UnknownUseNameElementName.name(), useNameElementName);
080        }
081
082        return useNameElement;
083    }
084
085    public UseNameElement getUseNameElementByName(final ExecutionErrorAccumulator eea, final String useNameElementName) {
086        return getUseNameElementByName(eea, useNameElementName, EntityPermission.READ_ONLY);
087    }
088
089    public UseNameElement getUseNameElementByNameForUpdate(final ExecutionErrorAccumulator eea, final String useNameElementName) {
090        return getUseNameElementByName(eea, useNameElementName, EntityPermission.READ_WRITE);
091    }
092
093    public UseNameElement getUseNameElementByUniversalSpec(final ExecutionErrorAccumulator eea,
094            final UseNameElementUniversalSpec universalSpec, final EntityPermission entityPermission) {
095        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
096        var useNameElementName = universalSpec.getUseNameElementName();
097        var parameterCount = (useNameElementName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
098        UseNameElement useNameElement = null;
099
100        if(parameterCount == 1) {
101            if(useNameElementName == null) {
102                var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
103                        ComponentVendors.ECHO_THREE.name(), EntityTypes.UseNameElement.name());
104
105                if(!eea.hasExecutionErrors()) {
106                    useNameElement = useNameElementControl.getUseNameElementByEntityInstance(entityInstance, entityPermission);
107                }
108            } else {
109                useNameElement = getUseNameElementByName(eea, useNameElementName, entityPermission);
110            }
111        } else {
112            handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
113        }
114
115        return useNameElement;
116    }
117
118    public UseNameElement getUseNameElementByUniversalSpec(final ExecutionErrorAccumulator eea,
119            final UseNameElementUniversalSpec universalSpec) {
120        return getUseNameElementByUniversalSpec(eea, universalSpec, EntityPermission.READ_ONLY);
121    }
122
123    public UseNameElement getUseNameElementByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
124            final UseNameElementUniversalSpec universalSpec) {
125        return getUseNameElementByUniversalSpec(eea, universalSpec, EntityPermission.READ_WRITE);
126    }
127
128    public void deleteUseNameElement(final ExecutionErrorAccumulator eea, final UseNameElement useNameElement,
129            final BasePK deletedBy) {
130        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
131
132        useNameElementControl.deleteUseNameElement(useNameElement, deletedBy);
133    }
134
135}