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