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.period.server.logic;
018
019import com.echothree.control.user.period.common.spec.PeriodKindUniversalSpec;
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.period.common.exception.DuplicatePeriodKindNameException;
025import com.echothree.model.control.period.common.exception.UnknownDefaultPeriodKindException;
026import com.echothree.model.control.period.common.exception.UnknownPeriodKindNameException;
027import com.echothree.model.control.period.server.control.PeriodControl;
028import com.echothree.model.data.party.server.entity.Language;
029import com.echothree.model.data.period.server.entity.PeriodKind;
030import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.persistence.BasePK;
033import com.echothree.util.server.control.BaseLogic;
034import com.echothree.util.server.message.ExecutionErrorAccumulator;
035import com.echothree.util.server.persistence.EntityPermission;
036import com.echothree.util.server.persistence.Session;
037import javax.enterprise.context.ApplicationScoped;
038import javax.enterprise.inject.spi.CDI;
039
040@ApplicationScoped
041public class PeriodKindLogic
042        extends BaseLogic {
043
044    protected PeriodKindLogic() {
045        super();
046    }
047
048    public static PeriodKindLogic getInstance() {
049        return CDI.current().select(PeriodKindLogic.class).get();
050    }
051
052    public PeriodKind createPeriodKind(final ExecutionErrorAccumulator eea, final String periodKindName,
053            final WorkflowEntrance workflowEntrance, final Boolean isDefault, final Integer sortOrder,
054            final Language language, final String description, final BasePK createdBy) {
055        var periodControl = Session.getModelController(PeriodControl.class);
056        var periodKind = periodControl.getPeriodKindByName(periodKindName);
057
058        if(periodKind == null) {
059            periodKind = periodControl.createPeriodKind(periodKindName, workflowEntrance, isDefault, sortOrder, createdBy);
060
061            if(description != null) {
062                periodControl.createPeriodKindDescription(periodKind, language, description, createdBy);
063            }
064        } else {
065            handleExecutionError(DuplicatePeriodKindNameException.class, eea, ExecutionErrors.DuplicatePeriodKindName.name(), periodKindName);
066        }
067
068        return periodKind;
069    }
070
071    public PeriodKind getPeriodKindByName(final ExecutionErrorAccumulator eea, final String periodKindName,
072            final EntityPermission entityPermission) {
073        var periodControl = Session.getModelController(PeriodControl.class);
074        var periodKind = periodControl.getPeriodKindByName(periodKindName, entityPermission);
075
076        if(periodKind == null) {
077            handleExecutionError(UnknownPeriodKindNameException.class, eea, ExecutionErrors.UnknownPeriodKindName.name(), periodKindName);
078        }
079
080        return periodKind;
081    }
082
083    public PeriodKind getPeriodKindByName(final ExecutionErrorAccumulator eea, final String periodKindName) {
084        return getPeriodKindByName(eea, periodKindName, EntityPermission.READ_ONLY);
085    }
086
087    public PeriodKind getPeriodKindByNameForUpdate(final ExecutionErrorAccumulator eea, final String periodKindName) {
088        return getPeriodKindByName(eea, periodKindName, EntityPermission.READ_WRITE);
089    }
090
091    public PeriodKind getPeriodKindByUniversalSpec(final ExecutionErrorAccumulator eea,
092            final PeriodKindUniversalSpec universalSpec, boolean allowDefault, final EntityPermission entityPermission) {
093        PeriodKind periodKind = null;
094        var periodControl = Session.getModelController(PeriodControl.class);
095        var periodKindName = universalSpec.getPeriodKindName();
096        var parameterCount = (periodKindName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
097
098        switch(parameterCount) {
099            case 0 -> {
100                if(allowDefault) {
101                    periodKind = periodControl.getDefaultPeriodKind(entityPermission);
102
103                    if(periodKind == null) {
104                        handleExecutionError(UnknownDefaultPeriodKindException.class, eea, ExecutionErrors.UnknownDefaultPeriodKind.name());
105                    }
106                } else {
107                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
108                }
109            }
110            case 1 -> {
111                if(periodKindName == null) {
112                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
113                            ComponentVendors.ECHO_THREE.name(), EntityTypes.PeriodKind.name());
114
115                    if(!eea.hasExecutionErrors()) {
116                        periodKind = periodControl.getPeriodKindByEntityInstance(entityInstance, entityPermission);
117                    }
118                } else {
119                    periodKind = getPeriodKindByName(eea, periodKindName, entityPermission);
120                }
121            }
122            default ->
123                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
124        }
125
126        return periodKind;
127    }
128
129    public PeriodKind getPeriodKindByUniversalSpec(final ExecutionErrorAccumulator eea,
130            final PeriodKindUniversalSpec universalSpec, boolean allowDefault) {
131        return getPeriodKindByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
132    }
133
134    public PeriodKind getPeriodKindByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
135            final PeriodKindUniversalSpec universalSpec, boolean allowDefault) {
136        return getPeriodKindByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
137    }
138
139    public void deletePeriodKind(final ExecutionErrorAccumulator eea, final PeriodKind periodKind,
140            final BasePK deletedBy) {
141        var periodControl = Session.getModelController(PeriodControl.class);
142
143        periodControl.deletePeriodKind(periodKind, deletedBy);
144    }
145
146}