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.edit.PeriodEditFactory;
020import com.echothree.control.user.period.common.edit.PeriodKindDescriptionEdit;
021import com.echothree.control.user.period.common.form.EditPeriodKindDescriptionForm;
022import com.echothree.control.user.period.common.result.PeriodResultFactory;
023import com.echothree.control.user.period.common.spec.PeriodKindDescriptionSpec;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.party.server.control.PartyControl;
026import com.echothree.model.control.period.server.control.PeriodControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042
043@Dependent
044public class EditPeriodKindDescriptionCommand
045        extends BaseEditCommand<PeriodKindDescriptionSpec, PeriodKindDescriptionEdit> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.PeriodKind.name(), SecurityRoles.Description.name())
056                        ))
057                ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("PeriodKindName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062                );
063        
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
066                );
067    }
068    
069    /** Creates a new instance of EditPeriodKindDescriptionCommand */
070    public EditPeriodKindDescriptionCommand() {
071        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var periodControl = Session.getModelController(PeriodControl.class);
077        var result = PeriodResultFactory.getEditPeriodKindDescriptionResult();
078        var periodKindName = spec.getPeriodKindName();
079        var periodKind = periodControl.getPeriodKindByName(periodKindName);
080
081        if(periodKind != null) {
082            var partyControl = Session.getModelController(PartyControl.class);
083            var languageIsoName = spec.getLanguageIsoName();
084            var language = partyControl.getLanguageByIsoName(languageIsoName);
085
086            if(language != null) {
087                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
088                    var periodKindDescription = periodControl.getPeriodKindDescription(periodKind, language);
089
090                    if(periodKindDescription != null) {
091                        if(editMode.equals(EditMode.LOCK)) {
092                            result.setPeriodKindDescription(periodControl.getPeriodKindDescriptionTransfer(getUserVisit(), periodKindDescription));
093
094                            if(lockEntity(periodKind)) {
095                                var edit = PeriodEditFactory.getPeriodKindDescriptionEdit();
096
097                                result.setEdit(edit);
098                                edit.setDescription(periodKindDescription.getDescription());
099                            } else {
100                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
101                            }
102
103                            result.setEntityLock(getEntityLockTransfer(periodKind));
104                        } else { // EditMode.ABANDON
105                            unlockEntity(periodKind);
106                        }
107                    } else {
108                        addExecutionError(ExecutionErrors.UnknownPeriodKindDescription.name());
109                    }
110                } else if(editMode.equals(EditMode.UPDATE)) {
111                    var periodKindDescription = periodControl.getPeriodKindDescriptionForUpdate(periodKind, language);
112                    var periodKindDescriptionValue = periodControl.getPeriodKindDescriptionValue(periodKindDescription);
113
114                    if(periodKindDescriptionValue != null) {
115                        if(lockEntityForUpdate(periodKind)) {
116                            try {
117                                var description = edit.getDescription();
118
119                                periodKindDescriptionValue.setDescription(description);
120
121                                periodControl.updatePeriodKindDescriptionFromValue(periodKindDescriptionValue, getPartyPK());
122                            } finally {
123                                unlockEntity(periodKind);
124                            }
125                        } else {
126                            addExecutionError(ExecutionErrors.EntityLockStale.name());
127                        }
128                    } else {
129                        addExecutionError(ExecutionErrors.UnknownPeriodKindDescription.name());
130                    }
131
132                    if(hasExecutionErrors()) {
133                        result.setPeriodKindDescription(periodControl.getPeriodKindDescriptionTransfer(getUserVisit(), periodKindDescription));
134                        result.setEntityLock(getEntityLockTransfer(periodKind));
135                    }
136                }
137            } else {
138                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
139            }
140        } else {
141            addExecutionError(ExecutionErrors.UnknownPeriodKindName.name(), periodKindName);
142        }
143
144        return result;
145    }
146
147}