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.term.server.logic;
018
019import com.echothree.control.user.term.common.spec.TermUniversalSpec;
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.term.common.exception.DuplicateTermNameException;
025import com.echothree.model.control.term.common.exception.UnknownDefaultTermException;
026import com.echothree.model.control.term.common.exception.UnknownPartyTermException;
027import com.echothree.model.control.term.common.exception.UnknownTermNameException;
028import com.echothree.model.control.term.server.control.TermControl;
029import com.echothree.model.data.party.server.entity.Language;
030import com.echothree.model.data.party.server.entity.Party;
031import com.echothree.model.data.term.server.entity.PartyTerm;
032import com.echothree.model.data.term.server.entity.Term;
033import com.echothree.model.data.term.server.entity.TermType;
034import com.echothree.model.data.term.server.value.TermDetailValue;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.persistence.BasePK;
037import com.echothree.util.server.control.BaseLogic;
038import com.echothree.util.server.message.ExecutionErrorAccumulator;
039import com.echothree.util.server.persistence.EntityPermission;
040import javax.enterprise.context.ApplicationScoped;
041import javax.enterprise.inject.spi.CDI;
042import javax.inject.Inject;
043
044@ApplicationScoped
045public class TermLogic
046        extends BaseLogic {
047
048    @Inject
049    TermControl termControl;
050
051    @Inject
052    EntityInstanceLogic entityInstanceLogic;
053
054    protected TermLogic() {
055        super();
056    }
057
058    public static TermLogic getInstance() {
059        return CDI.current().select(TermLogic.class).get();
060    }
061
062    public Term createTerm(final ExecutionErrorAccumulator eea, final String termName, final TermType termType,
063            final Boolean isDefault, final Integer sortOrder, final Language language, final String description,
064            final BasePK createdBy) {
065        var term = termControl.getTermByName(termName);
066
067        if(term == null) {
068            term = termControl.createTerm(termName, termType, isDefault, sortOrder, createdBy);
069
070            if(description != null) {
071                termControl.createTermDescription(term, language, description, createdBy);
072            }
073        } else {
074            handleExecutionError(DuplicateTermNameException.class, eea, ExecutionErrors.DuplicateTermName.name(), termName);
075        }
076
077        return term;
078    }
079
080    public Term getTermByName(final ExecutionErrorAccumulator eea, final String termName,
081            final EntityPermission entityPermission) {
082        var term = termControl.getTermByName(termName, entityPermission);
083
084        if(term == null) {
085            handleExecutionError(UnknownTermNameException.class, eea, ExecutionErrors.UnknownTermName.name(), termName);
086        }
087
088        return term;
089    }
090
091    public Term getTermByName(final ExecutionErrorAccumulator eea, final String termName) {
092        return getTermByName(eea, termName, EntityPermission.READ_ONLY);
093    }
094
095    public Term getTermByNameForUpdate(final ExecutionErrorAccumulator eea, final String termName) {
096        return getTermByName(eea, termName, EntityPermission.READ_WRITE);
097    }
098
099    public Term getTermByUniversalSpec(final ExecutionErrorAccumulator eea,
100            final TermUniversalSpec universalSpec, boolean allowDefault, final EntityPermission entityPermission) {
101        Term term = null;
102        var termName = universalSpec.getTermName();
103        var parameterCount = (termName == null ? 0 : 1) + entityInstanceLogic.countPossibleEntitySpecs(universalSpec);
104
105        switch(parameterCount) {
106            case 0 -> {
107                if(allowDefault) {
108                    term = termControl.getDefaultTerm(entityPermission);
109
110                    if(term == null) {
111                        handleExecutionError(UnknownDefaultTermException.class, eea, ExecutionErrors.UnknownDefaultTerm.name());
112                    }
113                } else {
114                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
115                }
116            }
117            case 1 -> {
118                if(termName == null) {
119                    var entityInstance = entityInstanceLogic.getEntityInstance(eea, universalSpec,
120                            ComponentVendors.ECHO_THREE.name(), EntityTypes.Term.name());
121
122                    if(eea == null || !eea.hasExecutionErrors()) {
123                        term = termControl.getTermByEntityInstance(entityInstance, entityPermission);
124                    }
125                } else {
126                    term = getTermByName(eea, termName, entityPermission);
127                }
128            }
129            default ->
130                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
131        }
132
133        return term;
134    }
135
136    public Term getTermByUniversalSpec(final ExecutionErrorAccumulator eea,
137            final TermUniversalSpec universalSpec, boolean allowDefault) {
138        return getTermByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
139    }
140
141    public Term getTermByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
142            final TermUniversalSpec universalSpec, boolean allowDefault) {
143        return getTermByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
144    }
145
146    public PartyTerm getPartyTerm(final ExecutionErrorAccumulator eea, final Party party) {
147        var partyTerm = termControl.getPartyTerm(party);
148
149        if(partyTerm == null) {
150            handleExecutionError(UnknownPartyTermException.class, eea, ExecutionErrors.UnknownPartyTerm.name(), party.getLastDetail().getPartyName());
151        }
152
153        return partyTerm;
154    }
155    
156    public Term getDefaultTerm(final ExecutionErrorAccumulator eea) {
157        var term = termControl.getDefaultTerm();
158
159        if(term == null) {
160            handleExecutionError(UnknownDefaultTermException.class, eea, ExecutionErrors.UnknownDefaultTerm.name());
161        }
162
163        return term;
164    }
165
166    public void updateTermFromValue(final ExecutionErrorAccumulator eea, TermDetailValue termDetailValue, BasePK updatedBy) {
167        termControl.updateTermFromValue(termDetailValue, updatedBy);
168    }
169
170    public void deleteTerm(final ExecutionErrorAccumulator eea, Term term, BasePK deletedBy) {
171        termControl.deleteTerm(term, deletedBy);
172    }
173
174}