001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.EditPeriodKindDescriptionResult;
023import com.echothree.control.user.period.common.result.PeriodResultFactory;
024import com.echothree.control.user.period.common.spec.PeriodKindDescriptionSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.period.server.control.PeriodControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.period.server.entity.PeriodKind;
032import com.echothree.model.data.period.server.entity.PeriodKindDescription;
033import com.echothree.model.data.period.server.value.PeriodKindDescriptionValue;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.BaseResult;
039import com.echothree.util.common.command.EditMode;
040import com.echothree.util.server.control.BaseEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.Arrays;
046import java.util.Collections;
047import java.util.List;
048
049public class EditPeriodKindDescriptionCommand
050        extends BaseEditCommand<PeriodKindDescriptionSpec, PeriodKindDescriptionEdit> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                        new SecurityRoleDefinition(SecurityRoleGroups.PeriodKind.name(), SecurityRoles.Description.name())
061                        )))
062                )));
063        
064        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("PeriodKindName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
067                ));
068        
069        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
070                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
071                ));
072    }
073    
074    /** Creates a new instance of EditPeriodKindDescriptionCommand */
075    public EditPeriodKindDescriptionCommand(UserVisitPK userVisitPK, EditPeriodKindDescriptionForm form) {
076        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078    
079    @Override
080    protected BaseResult execute() {
081        var periodControl = Session.getModelController(PeriodControl.class);
082        EditPeriodKindDescriptionResult result = PeriodResultFactory.getEditPeriodKindDescriptionResult();
083        String periodKindName = spec.getPeriodKindName();
084        PeriodKind periodKind = periodControl.getPeriodKindByName(periodKindName);
085
086        if(periodKind != null) {
087            var partyControl = Session.getModelController(PartyControl.class);
088            String languageIsoName = spec.getLanguageIsoName();
089            Language language = partyControl.getLanguageByIsoName(languageIsoName);
090
091            if(language != null) {
092                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093                    PeriodKindDescription 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                                PeriodKindDescriptionEdit 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                    PeriodKindDescription periodKindDescription = periodControl.getPeriodKindDescriptionForUpdate(periodKind, language);
117                    PeriodKindDescriptionValue periodKindDescriptionValue = periodControl.getPeriodKindDescriptionValue(periodKindDescription);
118
119                    if(periodKindDescriptionValue != null) {
120                        if(lockEntityForUpdate(periodKind)) {
121                            try {
122                                String 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}