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