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.party.server.command;
018
019import com.echothree.control.user.party.common.edit.BirthdayFormatDescriptionEdit;
020import com.echothree.control.user.party.common.edit.PartyEditFactory;
021import com.echothree.control.user.party.common.form.EditBirthdayFormatDescriptionForm;
022import com.echothree.control.user.party.common.result.EditBirthdayFormatDescriptionResult;
023import com.echothree.control.user.party.common.result.PartyResultFactory;
024import com.echothree.control.user.party.common.spec.BirthdayFormatDescriptionSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.party.server.entity.BirthdayFormat;
030import com.echothree.model.data.party.server.entity.BirthdayFormatDescription;
031import com.echothree.model.data.party.server.entity.Language;
032import com.echothree.model.data.party.server.value.BirthdayFormatDescriptionValue;
033import com.echothree.model.data.user.common.pk.UserVisitPK;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.common.command.EditMode;
038import com.echothree.util.server.control.BaseAbstractEditCommand;
039import com.echothree.util.server.control.CommandSecurityDefinition;
040import com.echothree.util.server.control.PartyTypeDefinition;
041import com.echothree.util.server.control.SecurityRoleDefinition;
042import com.echothree.util.server.persistence.Session;
043import java.util.Arrays;
044import java.util.Collections;
045import java.util.List;
046
047public class EditBirthdayFormatDescriptionCommand
048        extends BaseAbstractEditCommand<BirthdayFormatDescriptionSpec, BirthdayFormatDescriptionEdit, EditBirthdayFormatDescriptionResult, BirthdayFormatDescription, BirthdayFormat> {
049
050    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
051    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
052    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
053
054    static {
055        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
056                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
057                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
058                        new SecurityRoleDefinition(SecurityRoleGroups.BirthdayFormat.name(), SecurityRoles.Description.name())
059                        )))
060                )));
061
062        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
063                new FieldDefinition("BirthdayFormatName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
065                ));
066
067        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
069                ));
070    }
071
072    /** Creates a new instance of EditBirthdayFormatDescriptionCommand */
073    public EditBirthdayFormatDescriptionCommand(UserVisitPK userVisitPK, EditBirthdayFormatDescriptionForm form) {
074        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
075    }
076
077    @Override
078    public EditBirthdayFormatDescriptionResult getResult() {
079        return PartyResultFactory.getEditBirthdayFormatDescriptionResult();
080    }
081
082    @Override
083    public BirthdayFormatDescriptionEdit getEdit() {
084        return PartyEditFactory.getBirthdayFormatDescriptionEdit();
085    }
086
087    @Override
088    public BirthdayFormatDescription getEntity(EditBirthdayFormatDescriptionResult result) {
089        var partyControl = Session.getModelController(PartyControl.class);
090        BirthdayFormatDescription birthdayFormatDescription = null;
091        String birthdayFormatName = spec.getBirthdayFormatName();
092        BirthdayFormat birthdayFormat = partyControl.getBirthdayFormatByName(birthdayFormatName);
093
094        if(birthdayFormat != null) {
095            String languageIsoName = spec.getLanguageIsoName();
096            Language language = partyControl.getLanguageByIsoName(languageIsoName);
097
098            if(language != null) {
099                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
100                    birthdayFormatDescription = partyControl.getBirthdayFormatDescription(birthdayFormat, language);
101                } else { // EditMode.UPDATE
102                    birthdayFormatDescription = partyControl.getBirthdayFormatDescriptionForUpdate(birthdayFormat, language);
103                }
104
105                if(birthdayFormatDescription == null) {
106                    addExecutionError(ExecutionErrors.UnknownBirthdayFormatDescription.name(), birthdayFormatName, languageIsoName);
107                }
108            } else {
109                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
110            }
111        } else {
112            addExecutionError(ExecutionErrors.UnknownBirthdayFormatName.name(), birthdayFormatName);
113        }
114
115        return birthdayFormatDescription;
116    }
117
118    @Override
119    public BirthdayFormat getLockEntity(BirthdayFormatDescription birthdayFormatDescription) {
120        return birthdayFormatDescription.getBirthdayFormat();
121    }
122
123    @Override
124    public void fillInResult(EditBirthdayFormatDescriptionResult result, BirthdayFormatDescription birthdayFormatDescription) {
125        var partyControl = Session.getModelController(PartyControl.class);
126
127        result.setBirthdayFormatDescription(partyControl.getBirthdayFormatDescriptionTransfer(getUserVisit(), birthdayFormatDescription));
128    }
129
130    @Override
131    public void doLock(BirthdayFormatDescriptionEdit edit, BirthdayFormatDescription birthdayFormatDescription) {
132        edit.setDescription(birthdayFormatDescription.getDescription());
133    }
134
135    @Override
136    public void doUpdate(BirthdayFormatDescription birthdayFormatDescription) {
137        var partyControl = Session.getModelController(PartyControl.class);
138        BirthdayFormatDescriptionValue birthdayFormatDescriptionValue = partyControl.getBirthdayFormatDescriptionValue(birthdayFormatDescription);
139        birthdayFormatDescriptionValue.setDescription(edit.getDescription());
140
141        partyControl.updateBirthdayFormatDescriptionFromValue(birthdayFormatDescriptionValue, getPartyPK());
142    }
143
144}