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.core.server.command;
018
019import com.echothree.control.user.core.common.edit.CoreEditFactory;
020import com.echothree.control.user.core.common.edit.FontStyleEdit;
021import com.echothree.control.user.core.common.form.EditFontStyleForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.result.EditFontStyleResult;
024import com.echothree.control.user.core.common.spec.FontStyleSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.core.server.entity.FontStyle;
029import com.echothree.model.data.core.server.entity.FontStyleDescription;
030import com.echothree.model.data.core.server.entity.FontStyleDetail;
031import com.echothree.model.data.core.server.value.FontStyleDescriptionValue;
032import com.echothree.model.data.core.server.value.FontStyleDetailValue;
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 java.util.Arrays;
043import java.util.Collections;
044import java.util.List;
045
046public class EditFontStyleCommand
047        extends BaseAbstractEditCommand<FontStyleSpec, FontStyleEdit, EditFontStyleResult, FontStyle, FontStyle> {
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.FontStyle.name(), SecurityRoles.Edit.name())
058                        )))
059                )));
060        
061        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("FontStyleName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064        
065        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("FontStyleName", 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 EditFontStyleCommand */
074    public EditFontStyleCommand(UserVisitPK userVisitPK, EditFontStyleForm form) {
075        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077    
078    @Override
079    public EditFontStyleResult getResult() {
080        return CoreResultFactory.getEditFontStyleResult();
081    }
082
083    @Override
084    public FontStyleEdit getEdit() {
085        return CoreEditFactory.getFontStyleEdit();
086    }
087
088    @Override
089    public FontStyle getEntity(EditFontStyleResult result) {
090        var coreControl = getCoreControl();
091        FontStyle fontStyle;
092        String fontStyleName = spec.getFontStyleName();
093
094        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095            fontStyle = coreControl.getFontStyleByName(fontStyleName);
096        } else { // EditMode.UPDATE
097            fontStyle = coreControl.getFontStyleByNameForUpdate(fontStyleName);
098        }
099
100        if(fontStyle == null) {
101            addExecutionError(ExecutionErrors.UnknownFontStyleName.name(), fontStyleName);
102        }
103
104        return fontStyle;
105    }
106
107    @Override
108    public FontStyle getLockEntity(FontStyle fontStyle) {
109        return fontStyle;
110    }
111
112    @Override
113    public void fillInResult(EditFontStyleResult result, FontStyle fontStyle) {
114        var coreControl = getCoreControl();
115
116        result.setFontStyle(coreControl.getFontStyleTransfer(getUserVisit(), fontStyle));
117    }
118
119    @Override
120    public void doLock(FontStyleEdit edit, FontStyle fontStyle) {
121        var coreControl = getCoreControl();
122        FontStyleDescription fontStyleDescription = coreControl.getFontStyleDescription(fontStyle, getPreferredLanguage());
123        FontStyleDetail fontStyleDetail = fontStyle.getLastDetail();
124
125        edit.setFontStyleName(fontStyleDetail.getFontStyleName());
126        edit.setIsDefault(fontStyleDetail.getIsDefault().toString());
127        edit.setSortOrder(fontStyleDetail.getSortOrder().toString());
128
129        if(fontStyleDescription != null) {
130            edit.setDescription(fontStyleDescription.getDescription());
131        }
132    }
133
134    @Override
135    public void canUpdate(FontStyle fontStyle) {
136        var coreControl = getCoreControl();
137        String fontStyleName = edit.getFontStyleName();
138        FontStyle duplicateFontStyle = coreControl.getFontStyleByName(fontStyleName);
139
140        if(duplicateFontStyle != null && !fontStyle.equals(duplicateFontStyle)) {
141            addExecutionError(ExecutionErrors.DuplicateFontStyleName.name(), fontStyleName);
142        }
143    }
144
145    @Override
146    public void doUpdate(FontStyle fontStyle) {
147        var coreControl = getCoreControl();
148        var partyPK = getPartyPK();
149        FontStyleDetailValue fontStyleDetailValue = coreControl.getFontStyleDetailValueForUpdate(fontStyle);
150        FontStyleDescription fontStyleDescription = coreControl.getFontStyleDescriptionForUpdate(fontStyle, getPreferredLanguage());
151        String description = edit.getDescription();
152
153        fontStyleDetailValue.setFontStyleName(edit.getFontStyleName());
154        fontStyleDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
155        fontStyleDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
156
157        coreControl.updateFontStyleFromValue(fontStyleDetailValue, partyPK);
158
159        if(fontStyleDescription == null && description != null) {
160            coreControl.createFontStyleDescription(fontStyle, getPreferredLanguage(), description, partyPK);
161        } else {
162            if(fontStyleDescription != null && description == null) {
163                coreControl.deleteFontStyleDescription(fontStyleDescription, partyPK);
164            } else {
165                if(fontStyleDescription != null && description != null) {
166                    FontStyleDescriptionValue fontStyleDescriptionValue = coreControl.getFontStyleDescriptionValue(fontStyleDescription);
167
168                    fontStyleDescriptionValue.setDescription(description);
169                    coreControl.updateFontStyleDescriptionFromValue(fontStyleDescriptionValue, partyPK);
170                }
171            }
172        }
173    }
174    
175}