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.inject.Inject;
034
035@ApplicationScoped
036public class ContactListFrequencyLogic
037    extends BaseLogic {
038
039    @Inject
040    ContactListControl contactListControl;
041
042    @Inject
043    EntityInstanceLogic entityInstanceLogic;
044
045    protected ContactListFrequencyLogic() {
046        super();
047    }
048
049    public ContactListFrequency getContactListFrequencyByName(final ExecutionErrorAccumulator eea, final String contactListFrequencyName,
050            final EntityPermission entityPermission) {
051        var contactListFrequency = contactListControl.getContactListFrequencyByName(contactListFrequencyName, entityPermission);
052
053        if(contactListFrequency == null) {
054            handleExecutionError(UnknownContactListFrequencyNameException.class, eea, ExecutionErrors.UnknownContactListFrequencyName.name(),
055                    contactListFrequencyName);
056        }
057
058        return contactListFrequency;
059    }
060
061    public ContactListFrequency getContactListFrequencyByName(final ExecutionErrorAccumulator eea, final String contactListFrequencyName) {
062        return getContactListFrequencyByName(eea, contactListFrequencyName, EntityPermission.READ_ONLY);
063    }
064
065    public ContactListFrequency getContactListFrequencyByNameForUpdate(final ExecutionErrorAccumulator eea, final String contactListFrequencyName) {
066        return getContactListFrequencyByName(eea, contactListFrequencyName, EntityPermission.READ_WRITE);
067    }
068
069    public ContactListFrequency getContactListFrequencyByUniversalSpec(final ExecutionErrorAccumulator eea,
070            final ContactListFrequencyUniversalSpec universalSpec, final boolean allowDefault, final EntityPermission entityPermission) {
071        ContactListFrequency contactListFrequency = null;
072        var contactListFrequencyName = universalSpec.getContactListFrequencyName();
073        var parameterCount = (contactListFrequencyName == null ? 0 : 1) + entityInstanceLogic.countPossibleEntitySpecs(universalSpec);
074
075        switch(parameterCount) {
076            case 0 -> {
077                if(allowDefault) {
078                    contactListFrequency = contactListControl.getDefaultContactListFrequency(entityPermission);
079
080                    if(contactListFrequency == null) {
081                        handleExecutionError(UnknownDefaultContactListFrequencyException.class, eea, ExecutionErrors.UnknownDefaultContactListFrequency.name());
082                    }
083                } else {
084                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
085                }
086            }
087            case 1 -> {
088                if(contactListFrequencyName == null) {
089                    var entityInstance = entityInstanceLogic.getEntityInstance(eea, universalSpec,
090                            ComponentVendors.ECHO_THREE.name(), EntityTypes.ContactListFrequency.name());
091
092                    if(eea == null || !eea.hasExecutionErrors()) {
093                        contactListFrequency = contactListControl.getContactListFrequencyByEntityInstance(entityInstance, entityPermission);
094                    }
095                } else {
096                    contactListFrequency = getContactListFrequencyByName(eea, contactListFrequencyName, entityPermission);
097                }
098            }
099            default ->
100                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
101        }
102
103        return contactListFrequency;
104    }
105
106    public ContactListFrequency getContactListFrequencyByUniversalSpec(final ExecutionErrorAccumulator eea,
107            final ContactListFrequencyUniversalSpec universalSpec, final boolean allowDefault) {
108        return getContactListFrequencyByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
109    }
110
111    public ContactListFrequency getContactListFrequencyByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
112            final ContactListFrequencyUniversalSpec universalSpec, final boolean allowDefault) {
113        return getContactListFrequencyByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
114    }
115    
116}