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 java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
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    @Inject
070    PartyControl partyControl;
071
072    @Inject
073    PeriodControl periodControl;
074
075    
076    /** Creates a new instance of EditPeriodKindDescriptionCommand */
077    public EditPeriodKindDescriptionCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    protected BaseResult execute() {
083        var result = PeriodResultFactory.getEditPeriodKindDescriptionResult();
084        var periodKindName = spec.getPeriodKindName();
085        var periodKind = periodControl.getPeriodKindByName(periodKindName);
086
087        if(periodKind != null) {
088            var languageIsoName = spec.getLanguageIsoName();
089            var language = partyControl.getLanguageByIsoName(languageIsoName);
090
091            if(language != null) {
092                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093                    var periodKindDescription = periodControl.getPeriodKindDescription(periodKind, language);
094
095                    if(periodKindDescription != null) {
096                        if(editMode.equals(EditMode.LOCK)) {
097                            result.setPeriodKindDescription(periodControl.getPeriodKindDescriptionTransfer(getUserVisit(), periodKindDescription));
098
099                            if(lockEntity(periodKind)) {
100                                var edit = PeriodEditFactory.getPeriodKindDescriptionEdit();
101
102                                result.setEdit(edit);
103                                edit.setDescription(periodKindDescription.getDescription());
104                            } else {
105                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
106                            }
107
108                            result.setEntityLock(getEntityLockTransfer(periodKind));
109                        } else { // EditMode.ABANDON
110                            unlockEntity(periodKind);
111                        }
112                    } else {
113                        addExecutionError(ExecutionErrors.UnknownPeriodKindDescription.name());
114                    }
115                } else if(editMode.equals(EditMode.UPDATE)) {
116                    var periodKindDescription = periodControl.getPeriodKindDescriptionForUpdate(periodKind, language);
117                    var periodKindDescriptionValue = periodControl.getPeriodKindDescriptionValue(periodKindDescription);
118
119                    if(periodKindDescriptionValue != null) {
120                        if(lockEntityForUpdate(periodKind)) {
121                            try {
122                                var description = edit.getDescription();
123
124                                periodKindDescriptionValue.setDescription(description);
125
126                                periodControl.updatePeriodKindDescriptionFromValue(periodKindDescriptionValue, getPartyPK());
127                            } finally {
128                                unlockEntity(periodKind);
129                            }
130                        } else {
131                            addExecutionError(ExecutionErrors.EntityLockStale.name());
132                        }
133                    } else {
134                        addExecutionError(ExecutionErrors.UnknownPeriodKindDescription.name());
135                    }
136
137                    if(hasExecutionErrors()) {
138                        result.setPeriodKindDescription(periodControl.getPeriodKindDescriptionTransfer(getUserVisit(), periodKindDescription));
139                        result.setEntityLock(getEntityLockTransfer(periodKind));
140                    }
141                }
142            } else {
143                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
144            }
145        } else {
146            addExecutionError(ExecutionErrors.UnknownPeriodKindName.name(), periodKindName);
147        }
148
149        return result;
150    }
151
152}