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