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.result.EditPeriodKindDescriptionResult;
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.period.server.control.PeriodControl;
026import com.echothree.model.control.period.server.logic.PeriodKindLogic;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.period.server.entity.PeriodKind;
030import com.echothree.model.data.period.server.entity.PeriodKindDescription;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseAbstractEditCommand;
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 EditPeriodKindDescriptionCommand
043        extends BaseAbstractEditCommand<PeriodKindDescriptionSpec, PeriodKindDescriptionEdit, EditPeriodKindDescriptionResult, PeriodKindDescription, PeriodKind> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
047    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
048
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.PeriodKind.name(), SecurityRoles.Description.name())
054                ))
055        ));
056
057        SPEC_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("PeriodKindName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
060        );
061
062        EDIT_FIELD_DEFINITIONS = List.of(
063                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
064        );
065    }
066
067    @Inject
068    PeriodControl periodControl;
069
070    @Inject
071    PeriodKindLogic periodKindLogic;
072
073    /** Creates a new instance of EditPeriodKindDescriptionCommand */
074    public EditPeriodKindDescriptionCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077
078    @Override
079    public EditPeriodKindDescriptionResult getResult() {
080        return PeriodResultFactory.getEditPeriodKindDescriptionResult();
081    }
082
083    @Override
084    public PeriodKindDescriptionEdit getEdit() {
085        return PeriodEditFactory.getPeriodKindDescriptionEdit();
086    }
087
088    @Override
089    public PeriodKindDescription getEntity(EditPeriodKindDescriptionResult result) {
090        return periodKindLogic.getPeriodKindDescriptionBySpec(this, spec, editModeToEntityPermission(editMode));
091    }
092
093    @Override
094    public PeriodKind getLockEntity(PeriodKindDescription periodKindDescription) {
095        return periodKindDescription.getPeriodKind();
096    }
097
098    @Override
099    public void fillInResult(EditPeriodKindDescriptionResult result, PeriodKindDescription periodKindDescription) {
100        result.setPeriodKindDescription(periodControl.getPeriodKindDescriptionTransfer(getUserVisit(), periodKindDescription));
101    }
102
103    @Override
104    public void doLock(PeriodKindDescriptionEdit edit, PeriodKindDescription periodKindDescription) {
105        edit.setDescription(periodKindDescription.getDescription());
106    }
107
108    @Override
109    public void doUpdate(PeriodKindDescription periodKindDescription) {
110        var periodKindDescriptionValue = periodControl.getPeriodKindDescriptionValue(periodKindDescription);
111
112        periodKindDescriptionValue.setDescription(edit.getDescription());
113
114        periodControl.updatePeriodKindDescriptionFromValue(periodKindDescriptionValue, getPartyPK());
115    }
116
117}