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