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.control.user.period.server.command;
018
019import com.echothree.control.user.period.common.form.GetPeriodDescriptionForm;
020import com.echothree.control.user.period.common.result.PeriodResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.control.period.server.control.PeriodControl;
024import com.echothree.model.control.period.server.logic.PeriodKindLogic;
025import com.echothree.model.control.period.server.logic.PeriodLogic;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.period.server.entity.PeriodDescription;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSingleEntityCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetPeriodDescriptionCommand
043        extends BaseSingleEntityCommand<PeriodDescription, GetPeriodDescriptionForm> {
044
045    private static final CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private static final List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.Period.name(), SecurityRoles.Description.name())
053                ))
054        ));
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("PeriodKindName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("PeriodName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    PartyControl partyControl;
064
065    @Inject
066    PeriodControl periodControl;
067
068    @Inject
069    PeriodKindLogic periodKindLogic;
070
071    @Inject
072    PeriodLogic periodLogic;
073
074    public GetPeriodDescriptionCommand() {
075        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
076    }
077
078    @Override
079    protected PeriodDescription getEntity() {
080        var periodKind = periodKindLogic.getPeriodKindByName(this, form.getPeriodKindName());
081        PeriodDescription periodDescription = null;
082
083        if(!hasExecutionErrors()) {
084            var period = periodLogic.getPeriodByName(this, periodKind, form.getPeriodName());
085
086            if(!hasExecutionErrors()) {
087                var languageIsoName = form.getLanguageIsoName();
088                var language = partyControl.getLanguageByIsoName(languageIsoName);
089
090                if(language != null) {
091                    periodDescription = periodControl.getPeriodDescription(period, language);
092                    if(periodDescription == null) {
093                        addExecutionError(ExecutionErrors.UnknownPeriodDescription.name(), form.getPeriodKindName(),
094                                form.getPeriodName(), languageIsoName);
095                    }
096                } else {
097                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
098                }
099            }
100        }
101
102        return periodDescription;
103    }
104
105    @Override
106    protected BaseResult getResult(PeriodDescription periodDescription) {
107        var result = PeriodResultFactory.getGetPeriodDescriptionResult();
108
109        if(periodDescription != null) {
110            result.setPeriodDescription(periodControl.getPeriodDescriptionTransfer(getUserVisit(), periodDescription));
111        }
112
113        return result;
114    }
115
116}