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