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.party.server.command;
018
019import com.echothree.control.user.party.common.edit.BirthdayFormatEdit;
020import com.echothree.control.user.party.common.edit.PartyEditFactory;
021import com.echothree.control.user.party.common.form.EditBirthdayFormatForm;
022import com.echothree.control.user.party.common.result.EditBirthdayFormatResult;
023import com.echothree.control.user.party.common.result.PartyResultFactory;
024import com.echothree.control.user.party.common.spec.BirthdayFormatSpec;
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.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
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 EditBirthdayFormatCommand
047        extends BaseAbstractEditCommand<BirthdayFormatSpec, BirthdayFormatEdit, EditBirthdayFormatResult, BirthdayFormat, BirthdayFormat> {
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.BirthdayFormat.name(), SecurityRoles.Edit.name())
058                        )))
059                )));
060
061        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("BirthdayFormatName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064
065        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("BirthdayFormatName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
068                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
069                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
070                ));
071    }
072    
073    /** Creates a new instance of EditBirthdayFormatCommand */
074    public EditBirthdayFormatCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077    
078    @Override
079    public EditBirthdayFormatResult getResult() {
080        return PartyResultFactory.getEditBirthdayFormatResult();
081    }
082
083    @Override
084    public BirthdayFormatEdit getEdit() {
085        return PartyEditFactory.getBirthdayFormatEdit();
086    }
087
088    @Override
089    public BirthdayFormat getEntity(EditBirthdayFormatResult result) {
090        var partyControl = Session.getModelController(PartyControl.class);
091        BirthdayFormat birthdayFormat;
092        var birthdayFormatName = spec.getBirthdayFormatName();
093
094        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095            birthdayFormat = partyControl.getBirthdayFormatByName(birthdayFormatName);
096        } else { // EditMode.UPDATE
097            birthdayFormat = partyControl.getBirthdayFormatByNameForUpdate(birthdayFormatName);
098        }
099
100        if(birthdayFormat != null) {
101            result.setBirthdayFormat(partyControl.getBirthdayFormatTransfer(getUserVisit(), birthdayFormat));
102        } else {
103            addExecutionError(ExecutionErrors.UnknownBirthdayFormatName.name(), birthdayFormatName);
104        }
105
106        return birthdayFormat;
107    }
108
109    @Override
110    public BirthdayFormat getLockEntity(BirthdayFormat birthdayFormat) {
111        return birthdayFormat;
112    }
113
114    @Override
115    public void fillInResult(EditBirthdayFormatResult result, BirthdayFormat birthdayFormat) {
116        var partyControl = Session.getModelController(PartyControl.class);
117
118        result.setBirthdayFormat(partyControl.getBirthdayFormatTransfer(getUserVisit(), birthdayFormat));
119    }
120
121    @Override
122    public void doLock(BirthdayFormatEdit edit, BirthdayFormat birthdayFormat) {
123        var partyControl = Session.getModelController(PartyControl.class);
124        var birthdayFormatDescription = partyControl.getBirthdayFormatDescription(birthdayFormat, getPreferredLanguage());
125        var birthdayFormatDetail = birthdayFormat.getLastDetail();
126
127        edit.setBirthdayFormatName(birthdayFormatDetail.getBirthdayFormatName());
128        edit.setIsDefault(birthdayFormatDetail.getIsDefault().toString());
129        edit.setSortOrder(birthdayFormatDetail.getSortOrder().toString());
130
131        if(birthdayFormatDescription != null) {
132            edit.setDescription(birthdayFormatDescription.getDescription());
133        }
134    }
135
136    @Override
137    public void canUpdate(BirthdayFormat birthdayFormat) {
138        var partyControl = Session.getModelController(PartyControl.class);
139        var birthdayFormatName = edit.getBirthdayFormatName();
140        var duplicateBirthdayFormat = partyControl.getBirthdayFormatByName(birthdayFormatName);
141
142        if(duplicateBirthdayFormat != null && !birthdayFormat.equals(duplicateBirthdayFormat)) {
143            addExecutionError(ExecutionErrors.DuplicateBirthdayFormatName.name(), birthdayFormatName);
144        }
145    }
146
147    @Override
148    public void doUpdate(BirthdayFormat birthdayFormat) {
149        var partyControl = Session.getModelController(PartyControl.class);
150        var partyPK = getPartyPK();
151        var birthdayFormatDetailValue = partyControl.getBirthdayFormatDetailValueForUpdate(birthdayFormat);
152        var birthdayFormatDescription = partyControl.getBirthdayFormatDescriptionForUpdate(birthdayFormat, getPreferredLanguage());
153        var description = edit.getDescription();
154
155        birthdayFormatDetailValue.setBirthdayFormatName(edit.getBirthdayFormatName());
156        birthdayFormatDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
157        birthdayFormatDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
158
159        partyControl.updateBirthdayFormatFromValue(birthdayFormatDetailValue, partyPK);
160
161        if(birthdayFormatDescription == null && description != null) {
162            partyControl.createBirthdayFormatDescription(birthdayFormat, getPreferredLanguage(), description, partyPK);
163        } else if(birthdayFormatDescription != null && description == null) {
164            partyControl.deleteBirthdayFormatDescription(birthdayFormatDescription, partyPK);
165        } else if(birthdayFormatDescription != null && description != null) {
166            var birthdayFormatDescriptionValue = partyControl.getBirthdayFormatDescriptionValue(birthdayFormatDescription);
167
168            birthdayFormatDescriptionValue.setDescription(description);
169            partyControl.updateBirthdayFormatDescriptionFromValue(birthdayFormatDescriptionValue, partyPK);
170        }
171    }
172
173}