001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.core.server.logic;
018
019import com.echothree.control.user.core.common.spec.EntityAttributeGroupUniversalSpec;
020import com.echothree.model.control.core.common.ComponentVendors;
021import com.echothree.model.control.core.common.EntityTypes;
022import com.echothree.model.control.core.common.exception.DuplicateEntityAttributeGroupNameException;
023import com.echothree.model.control.core.common.exception.InvalidParameterCountException;
024import com.echothree.model.control.core.common.exception.UnknownEntityAttributeGroupNameException;
025import com.echothree.model.control.sequence.common.SequenceTypes;
026import com.echothree.model.control.sequence.server.control.SequenceControl;
027import com.echothree.model.control.sequence.server.logic.SequenceGeneratorLogic;
028import com.echothree.model.data.core.server.entity.EntityAttributeGroup;
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 javax.enterprise.context.ApplicationScoped;
036import javax.enterprise.inject.spi.CDI;
037import javax.inject.Inject;
038
039@ApplicationScoped
040public class EntityAttributeGroupLogic
041        extends BaseLogic {
042
043    @Inject
044    protected SequenceControl sequenceControl;
045
046    @Inject
047    protected EntityInstanceLogic entityInstanceLogic;
048
049    @Inject
050    protected SequenceGeneratorLogic sequenceGeneratorLogic;
051
052    protected EntityAttributeGroupLogic() {
053        super();
054    }
055
056    public static EntityAttributeGroupLogic getInstance() {
057        return CDI.current().select(EntityAttributeGroupLogic.class).get();
058    }
059    
060    public EntityAttributeGroup createEntityAttributeGroup(final ExecutionErrorAccumulator eea, String entityAttributeGroupName,
061            final Boolean isDefault, final Integer sortOrder, final String description, final Language language, final BasePK createdBy) {
062        if(entityAttributeGroupName == null) {
063            var sequence = sequenceControl.getDefaultSequenceUsingNames(SequenceTypes.ENTITY_ATTRIBUTE_GROUP.name());
064            
065            entityAttributeGroupName = sequenceGeneratorLogic.getNextSequenceValue(sequence);
066        }
067
068        var entityAttributeGroup = coreControl.getEntityAttributeGroupByName(entityAttributeGroupName);
069        
070        if(entityAttributeGroup == null) {
071            entityAttributeGroup = coreControl.createEntityAttributeGroup(entityAttributeGroupName, isDefault, sortOrder, createdBy);
072
073            if(description != null) {
074                coreControl.createEntityAttributeGroupDescription(entityAttributeGroup, language, description, createdBy);
075            }
076        } else {
077            handleExecutionError(DuplicateEntityAttributeGroupNameException.class, eea, ExecutionErrors.DuplicateEntityAttributeGroupName.name(),
078                    entityAttributeGroupName);
079        }
080
081        return entityAttributeGroup;
082    }
083
084    public EntityAttributeGroup getEntityAttributeGroupByName(final ExecutionErrorAccumulator eea, final String entityAttributeGroupName,
085            final EntityPermission entityPermission) {
086        var entityAttributeGroup = coreControl.getEntityAttributeGroupByName(entityAttributeGroupName, entityPermission);
087
088        if(entityAttributeGroup == null) {
089            handleExecutionError(UnknownEntityAttributeGroupNameException.class, eea, ExecutionErrors.UnknownEntityAttributeGroupName.name(), entityAttributeGroupName);
090        }
091
092        return entityAttributeGroup;
093    }
094
095    public EntityAttributeGroup getEntityAttributeGroupByName(final ExecutionErrorAccumulator eea, final String entityAttributeGroupName) {
096        return getEntityAttributeGroupByName(eea, entityAttributeGroupName, EntityPermission.READ_ONLY);
097    }
098
099    public EntityAttributeGroup getEntityAttributeGroupByNameForUpdate(final ExecutionErrorAccumulator eea, final String entityAttributeGroupName) {
100        return getEntityAttributeGroupByName(eea, entityAttributeGroupName, EntityPermission.READ_WRITE);
101    }
102
103    public EntityAttributeGroup getEntityAttributeGroupByUniversalSpec(final ExecutionErrorAccumulator eea,
104            final EntityAttributeGroupUniversalSpec universalSpec, final EntityPermission entityPermission) {
105        EntityAttributeGroup entityAttributeGroup = null;
106        var entityAttributeGroupName = universalSpec.getEntityAttributeGroupName();
107        var parameterCount = (entityAttributeGroupName == null ? 0 : 1) + entityInstanceLogic.countPossibleEntitySpecs(universalSpec);
108
109        switch(parameterCount) {
110            case 1 -> {
111                if(entityAttributeGroupName == null) {
112                    var entityInstance = entityInstanceLogic.getEntityInstance(eea, universalSpec,
113                            ComponentVendors.ECHO_THREE.name(), EntityTypes.EntityAttributeGroup.name());
114
115                    if(!eea.hasExecutionErrors()) {
116                        entityAttributeGroup = coreControl.getEntityAttributeGroupByEntityInstance(entityInstance, entityPermission);
117                    }
118                } else {
119                    entityAttributeGroup = getEntityAttributeGroupByName(eea, entityAttributeGroupName, entityPermission);
120                }
121            }
122            default ->
123                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
124        }
125
126        return entityAttributeGroup;
127    }
128
129    public EntityAttributeGroup getEntityAttributeGroupByUniversalSpec(final ExecutionErrorAccumulator eea,
130            final EntityAttributeGroupUniversalSpec universalSpec) {
131        return getEntityAttributeGroupByUniversalSpec(eea, universalSpec, EntityPermission.READ_ONLY);
132    }
133
134    public EntityAttributeGroup getEntityAttributeGroupByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
135            final EntityAttributeGroupUniversalSpec universalSpec) {
136        return getEntityAttributeGroupByUniversalSpec(eea, universalSpec, EntityPermission.READ_WRITE);
137    }
138
139}