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.user.server.logic;
018
019import com.echothree.control.user.user.common.spec.UserVisitGroupUniversalSpec;
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.user.common.exception.UnknownUserVisitGroupNameException;
025import com.echothree.model.control.user.server.control.UserControl;
026import com.echothree.model.data.user.server.entity.UserVisitGroup;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.server.control.BaseLogic;
029import com.echothree.util.server.message.ExecutionErrorAccumulator;
030import com.echothree.util.server.persistence.EntityPermission;
031import javax.enterprise.context.ApplicationScoped;
032import javax.enterprise.inject.spi.CDI;
033import javax.inject.Inject;
034
035@ApplicationScoped
036public class UserVisitGroupLogic
037        extends BaseLogic {
038
039    @Inject
040    UserControl userControl;
041
042    @Inject
043    EntityInstanceLogic entityInstanceLogic;
044
045    protected UserVisitGroupLogic() {
046        super();
047    }
048
049    public static UserVisitGroupLogic getInstance() {
050        return CDI.current().select(UserVisitGroupLogic.class).get();
051    }
052
053    public UserVisitGroup getUserVisitGroupByName(final ExecutionErrorAccumulator eea, final String userVisitGroupName,
054            final EntityPermission entityPermission) {
055        var userVisitGroup = userControl.getUserVisitGroupByName(userVisitGroupName, entityPermission);
056
057        if(userVisitGroup == null) {
058            handleExecutionError(UnknownUserVisitGroupNameException.class, eea, ExecutionErrors.UnknownUserVisitGroupName.name(), userVisitGroupName);
059        }
060
061        return userVisitGroup;
062    }
063
064    public UserVisitGroup getUserVisitGroupByName(final ExecutionErrorAccumulator eea, final String userVisitGroupName) {
065        return getUserVisitGroupByName(eea, userVisitGroupName, EntityPermission.READ_ONLY);
066    }
067
068    public UserVisitGroup getUserVisitGroupByNameForUpdate(final ExecutionErrorAccumulator eea, final String userVisitGroupName) {
069        return getUserVisitGroupByName(eea, userVisitGroupName, EntityPermission.READ_WRITE);
070    }
071
072    public UserVisitGroup getUserVisitGroupByUniversalSpec(final ExecutionErrorAccumulator eea,
073            final UserVisitGroupUniversalSpec universalSpec, final EntityPermission entityPermission) {
074        UserVisitGroup userVisitGroup = null;
075        var userVisitGroupName = universalSpec.getUserVisitGroupName();
076        var parameterCount = (userVisitGroupName == null ? 0 : 1) + entityInstanceLogic.countPossibleEntitySpecs(universalSpec);
077
078        switch(parameterCount) {
079            case 1 -> {
080                if(userVisitGroupName == null) {
081                    var entityInstance = entityInstanceLogic.getEntityInstance(eea, universalSpec,
082                            ComponentVendors.ECHO_THREE.name(), EntityTypes.UserVisitGroup.name());
083
084                    if(eea == null || !eea.hasExecutionErrors()) {
085                        userVisitGroup = userControl.getUserVisitGroupByEntityInstance(entityInstance, entityPermission);
086                    }
087                } else {
088                    userVisitGroup = getUserVisitGroupByName(eea, userVisitGroupName, entityPermission);
089                }
090            }
091            default ->
092                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
093        }
094
095        return userVisitGroup;
096    }
097
098    public UserVisitGroup getUserVisitGroupByUniversalSpec(final ExecutionErrorAccumulator eea,
099            final UserVisitGroupUniversalSpec universalSpec) {
100        return getUserVisitGroupByUniversalSpec(eea, universalSpec, EntityPermission.READ_ONLY);
101    }
102
103    public UserVisitGroup getUserVisitGroupByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
104            final UserVisitGroupUniversalSpec universalSpec) {
105        return getUserVisitGroupByUniversalSpec(eea, universalSpec, EntityPermission.READ_WRITE);
106    }
107
108}