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.selector.server.logic;
018
019import com.echothree.control.user.selector.common.spec.SelectorKindUniversalSpec;
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.selector.common.exception.DuplicateSelectorKindNameException;
025import com.echothree.model.control.selector.common.exception.UnknownDefaultSelectorKindException;
026import com.echothree.model.control.selector.common.exception.UnknownSelectorKindNameException;
027import com.echothree.model.control.selector.server.control.SelectorControl;
028import com.echothree.model.data.core.server.entity.EntityInstance;
029import com.echothree.model.data.selector.server.entity.SelectorKind;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.persistence.BasePK;
033import com.echothree.util.server.control.BaseLogic;
034import com.echothree.util.server.message.ExecutionErrorAccumulator;
035import com.echothree.util.server.persistence.EntityPermission;
036import com.echothree.util.server.persistence.Session;
037
038public class SelectorKindLogic
039        extends BaseLogic {
040
041    private SelectorKindLogic() {
042        super();
043    }
044
045    private static class SelectorKindLogicHolder {
046        static SelectorKindLogic instance = new SelectorKindLogic();
047    }
048
049    public static SelectorKindLogic getInstance() {
050        return SelectorKindLogic.SelectorKindLogicHolder.instance;
051    }
052
053    public SelectorKind createSelectorKind(final ExecutionErrorAccumulator eea, final String selectorKindName,
054            final Boolean isDefault, final Integer sortOrder, final Language language, final String description,
055            final BasePK createdBy) {
056        var selectorControl = Session.getModelController(SelectorControl.class);
057        var selectorKind = selectorControl.getSelectorKindByName(selectorKindName);
058
059        if(selectorKind == null) {
060            selectorKind = selectorControl.createSelectorKind(selectorKindName, isDefault, sortOrder, createdBy);
061
062            if(description != null) {
063                selectorControl.createSelectorKindDescription(selectorKind, language, description, createdBy);
064            }
065        } else {
066            handleExecutionError(DuplicateSelectorKindNameException.class, eea, ExecutionErrors.DuplicateSelectorKindName.name(), selectorKindName);
067        }
068
069        return selectorKind;
070    }
071
072    public SelectorKind getSelectorKindByName(final ExecutionErrorAccumulator eea, final String selectorKindName,
073            final EntityPermission entityPermission) {
074        var selectorControl = Session.getModelController(SelectorControl.class);
075        var selectorKind = selectorControl.getSelectorKindByName(selectorKindName, entityPermission);
076
077        if(selectorKind == null) {
078            handleExecutionError(UnknownSelectorKindNameException.class, eea, ExecutionErrors.UnknownSelectorKindName.name(), selectorKindName);
079        }
080
081        return selectorKind;
082    }
083
084    public SelectorKind getSelectorKindByName(final ExecutionErrorAccumulator eea, final String selectorKindName) {
085        return getSelectorKindByName(eea, selectorKindName, EntityPermission.READ_ONLY);
086    }
087
088    public SelectorKind getSelectorKindByNameForUpdate(final ExecutionErrorAccumulator eea, final String selectorKindName) {
089        return getSelectorKindByName(eea, selectorKindName, EntityPermission.READ_WRITE);
090    }
091
092    public SelectorKind getSelectorKindByUniversalSpec(final ExecutionErrorAccumulator eea,
093            final SelectorKindUniversalSpec universalSpec, boolean allowDefault, final EntityPermission entityPermission) {
094        SelectorKind selectorKind = null;
095        var selectorControl = Session.getModelController(SelectorControl.class);
096        var selectorKindName = universalSpec.getSelectorKindName();
097        var parameterCount = (selectorKindName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
098
099        switch(parameterCount) {
100            case 0:
101                if(allowDefault) {
102                    selectorKind = selectorControl.getDefaultSelectorKind(entityPermission);
103
104                    if(selectorKind == null) {
105                        handleExecutionError(UnknownDefaultSelectorKindException.class, eea, ExecutionErrors.UnknownDefaultSelectorKind.name());
106                    }
107                } else {
108                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
109                }
110                break;
111            case 1:
112                if(selectorKindName == null) {
113                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
114                            ComponentVendors.ECHO_THREE.name(), EntityTypes.SelectorKind.name());
115
116                    if(!eea.hasExecutionErrors()) {
117                        selectorKind = selectorControl.getSelectorKindByEntityInstance(entityInstance, entityPermission);
118                    }
119                } else {
120                    selectorKind = getSelectorKindByName(eea, selectorKindName, entityPermission);
121                }
122                break;
123            default:
124                handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
125                break;
126        }
127
128        return selectorKind;
129    }
130
131    public SelectorKind getSelectorKindByUniversalSpec(final ExecutionErrorAccumulator eea,
132            final SelectorKindUniversalSpec universalSpec, boolean allowDefault) {
133        return getSelectorKindByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
134    }
135
136    public SelectorKind getSelectorKindByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
137            final SelectorKindUniversalSpec universalSpec, boolean allowDefault) {
138        return getSelectorKindByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
139    }
140
141    public void deleteSelectorKind(final ExecutionErrorAccumulator eea, final SelectorKind selectorKind,
142            final BasePK deletedBy) {
143        var selectorControl = Session.getModelController(SelectorControl.class);
144
145        selectorControl.deleteSelectorKind(selectorKind, deletedBy);
146    }
147
148}