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.contactlist.server.logic;
018
019import com.echothree.control.user.contactlist.common.spec.ContactListFrequencyUniversalSpec;
020import com.echothree.model.control.contactlist.common.exception.UnknownContactListFrequencyNameException;
021import com.echothree.model.control.contactlist.common.exception.UnknownDefaultContactListFrequencyException;
022import com.echothree.model.control.contactlist.server.control.ContactListControl;
023import com.echothree.model.control.core.common.ComponentVendors;
024import com.echothree.model.control.core.common.EntityTypes;
025import com.echothree.model.control.core.common.exception.InvalidParameterCountException;
026import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
027import com.echothree.model.data.contactlist.server.entity.ContactListFrequency;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.server.control.BaseLogic;
030import com.echothree.util.server.message.ExecutionErrorAccumulator;
031import com.echothree.util.server.persistence.EntityPermission;
032import javax.enterprise.context.ApplicationScoped;
033import javax.enterprise.inject.spi.CDI;
034import javax.inject.Inject;
035
036@ApplicationScoped
037public class ContactListFrequencyLogic
038    extends BaseLogic {
039
040    protected ContactListFrequencyLogic() {
041        super();
042    }
043
044    public static ContactListFrequencyLogic getInstance() {
045        return CDI.current().select(ContactListFrequencyLogic.class).get();
046    }
047    
048    @Inject
049    ContactListControl contactListControl;
050
051    public ContactListFrequency getContactListFrequencyByName(final ExecutionErrorAccumulator eea, final String contactListFrequencyName,
052            final EntityPermission entityPermission) {
053        var contactListFrequency = contactListControl.getContactListFrequencyByName(contactListFrequencyName, entityPermission);
054
055        if(contactListFrequency == null) {
056            handleExecutionError(UnknownContactListFrequencyNameException.class, eea, ExecutionErrors.UnknownContactListFrequencyName.name(),
057                    contactListFrequencyName);
058        }
059
060        return contactListFrequency;
061    }
062
063    public ContactListFrequency getContactListFrequencyByName(final ExecutionErrorAccumulator eea, final String contactListFrequencyName) {
064        return getContactListFrequencyByName(eea, contactListFrequencyName, EntityPermission.READ_ONLY);
065    }
066
067    public ContactListFrequency getContactListFrequencyByNameForUpdate(final ExecutionErrorAccumulator eea, final String contactListFrequencyName) {
068        return getContactListFrequencyByName(eea, contactListFrequencyName, EntityPermission.READ_WRITE);
069    }
070
071    public ContactListFrequency getContactListFrequencyByUniversalSpec(final ExecutionErrorAccumulator eea,
072            final ContactListFrequencyUniversalSpec universalSpec, final boolean allowDefault, final EntityPermission entityPermission) {
073        ContactListFrequency contactListFrequency = null;
074        var contactListFrequencyName = universalSpec.getContactListFrequencyName();
075        var parameterCount = (contactListFrequencyName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
076
077        switch(parameterCount) {
078            case 0 -> {
079                if(allowDefault) {
080                    contactListFrequency = contactListControl.getDefaultContactListFrequency(entityPermission);
081
082                    if(contactListFrequency == null) {
083                        handleExecutionError(UnknownDefaultContactListFrequencyException.class, eea, ExecutionErrors.UnknownDefaultContactListFrequency.name());
084                    }
085                } else {
086                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
087                }
088            }
089            case 1 -> {
090                if(contactListFrequencyName == null) {
091                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
092                            ComponentVendors.ECHO_THREE.name(), EntityTypes.ContactListFrequency.name());
093
094                    if(!eea.hasExecutionErrors()) {
095                        contactListFrequency = contactListControl.getContactListFrequencyByEntityInstance(entityInstance, entityPermission);
096                    }
097                } else {
098                    contactListFrequency = getContactListFrequencyByName(eea, contactListFrequencyName, entityPermission);
099                }
100            }
101            default ->
102                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
103        }
104
105        return contactListFrequency;
106    }
107
108    public ContactListFrequency getContactListFrequencyByUniversalSpec(final ExecutionErrorAccumulator eea,
109            final ContactListFrequencyUniversalSpec universalSpec, final boolean allowDefault) {
110        return getContactListFrequencyByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
111    }
112
113    public ContactListFrequency getContactListFrequencyByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
114            final ContactListFrequencyUniversalSpec universalSpec, final boolean allowDefault) {
115        return getContactListFrequencyByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
116    }
117    
118}