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.offer.server.command;
018
019import com.echothree.control.user.offer.common.edit.OfferEditFactory;
020import com.echothree.control.user.offer.common.edit.UseNameElementEdit;
021import com.echothree.control.user.offer.common.form.EditUseNameElementForm;
022import com.echothree.control.user.offer.common.result.EditUseNameElementResult;
023import com.echothree.control.user.offer.common.result.OfferResultFactory;
024import com.echothree.control.user.offer.common.spec.UseNameElementUniversalSpec;
025import com.echothree.model.control.offer.server.control.UseNameElementControl;
026import com.echothree.model.control.offer.server.logic.UseNameElementLogic;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.offer.server.entity.UseNameElement;
031import com.echothree.model.data.offer.server.entity.UseNameElementDescription;
032import com.echothree.model.data.offer.server.entity.UseNameElementDetail;
033import com.echothree.model.data.offer.server.value.UseNameElementDescriptionValue;
034import com.echothree.model.data.offer.server.value.UseNameElementDetailValue;
035import com.echothree.model.data.user.common.pk.UserVisitPK;
036import com.echothree.util.common.message.ExecutionErrors;
037import com.echothree.util.common.validation.FieldDefinition;
038import com.echothree.util.common.validation.FieldType;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.persistence.Session;
044import java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047
048public class EditUseNameElementCommand
049        extends BaseAbstractEditCommand<UseNameElementUniversalSpec, UseNameElementEdit, EditUseNameElementResult, UseNameElement, UseNameElement> {
050    
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054    
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
059                        new SecurityRoleDefinition(SecurityRoleGroups.UseNameElement.name(), SecurityRoles.Edit.name())
060                        )))
061                )));
062        
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("UseNameElementName", FieldType.ENTITY_NAME, false, null, null),
065                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
066                new FieldDefinition("Key", FieldType.KEY, false, null, null),
067                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
068                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
069                ));
070        
071        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
072                new FieldDefinition("UseNameElementName", FieldType.ENTITY_NAME, true, null, null),
073                new FieldDefinition("Offset", FieldType.UNSIGNED_INTEGER, true, null, null),
074                new FieldDefinition("Length", FieldType.UNSIGNED_INTEGER, true, null, null),
075                new FieldDefinition("ValidationPattern", FieldType.REGULAR_EXPRESSION, false, null, null),
076                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
077                ));
078    }
079    
080    /** Creates a new instance of EditUseNameElementCommand */
081    public EditUseNameElementCommand(UserVisitPK userVisitPK, EditUseNameElementForm form) {
082        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084    
085    @Override
086    public EditUseNameElementResult getResult() {
087        return OfferResultFactory.getEditUseNameElementResult();
088    }
089    
090    @Override
091    public UseNameElementEdit getEdit() {
092        return OfferEditFactory.getUseNameElementEdit();
093    }
094    
095    @Override
096    public UseNameElement getEntity(EditUseNameElementResult result) {
097        return UseNameElementLogic.getInstance().getUseNameElementByUniversalSpec(this, spec, editModeToEntityPermission(editMode));
098    }
099    
100    @Override
101    public UseNameElement getLockEntity(UseNameElement useNameElement) {
102        return useNameElement;
103    }
104    
105    @Override
106    public void fillInResult(EditUseNameElementResult result, UseNameElement useNameElement) {
107        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
108        
109        result.setUseNameElement(useNameElementControl.getUseNameElementTransfer(getUserVisit(), useNameElement));
110    }
111    
112    @Override
113    public void doLock(UseNameElementEdit edit, UseNameElement useNameElement) {
114        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
115        UseNameElementDescription useNameElementDescription = useNameElementControl.getUseNameElementDescription(useNameElement, getPreferredLanguage());
116        UseNameElementDetail useNameElementDetail = useNameElement.getLastDetail();
117        
118        edit.setUseNameElementName(useNameElementDetail.getUseNameElementName());
119        edit.setOffset(useNameElementDetail.getOffset().toString());
120        edit.setLength(useNameElementDetail.getLength().toString());
121        edit.setValidationPattern(useNameElementDetail.getValidationPattern());
122
123        if(useNameElementDescription != null) {
124            edit.setDescription(useNameElementDescription.getDescription());
125        }
126    }
127        
128    @Override
129    public void canUpdate(UseNameElement useNameElement) {
130        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
131        String useNameElementName = edit.getUseNameElementName();
132        UseNameElement duplicateUseNameElement = useNameElementControl.getUseNameElementByName(useNameElementName);
133
134        if(duplicateUseNameElement != null && !useNameElement.equals(duplicateUseNameElement)) {
135            addExecutionError(ExecutionErrors.DuplicateUseNameElementName.name(), useNameElementName);
136        }
137    }
138    
139    @Override
140    public void doUpdate(UseNameElement useNameElement) {
141        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
142        var partyPK = getPartyPK();
143        UseNameElementDetailValue useNameElementDetailValue = useNameElementControl.getUseNameElementDetailValueForUpdate(useNameElement);
144        UseNameElementDescription useNameElementDescription = useNameElementControl.getUseNameElementDescriptionForUpdate(useNameElement, getPreferredLanguage());
145        String description = edit.getDescription();
146
147        useNameElementDetailValue.setUseNameElementName(edit.getUseNameElementName());
148        useNameElementDetailValue.setOffset(Integer.valueOf(edit.getOffset()));
149        useNameElementDetailValue.setLength(Integer.valueOf(edit.getLength()));
150        useNameElementDetailValue.setValidationPattern(edit.getValidationPattern());
151
152        useNameElementControl.updateUseNameElementFromValue(useNameElementDetailValue, partyPK);
153
154        if(useNameElementDescription == null && description != null) {
155            useNameElementControl.createUseNameElementDescription(useNameElement, getPreferredLanguage(), description, partyPK);
156        } else if(useNameElementDescription != null && description == null) {
157            useNameElementControl.deleteUseNameElementDescription(useNameElementDescription, partyPK);
158        } else if(useNameElementDescription != null && description != null) {
159            UseNameElementDescriptionValue useNameElementDescriptionValue = useNameElementControl.getUseNameElementDescriptionValue(useNameElementDescription);
160
161            useNameElementDescriptionValue.setDescription(description);
162            useNameElementControl.updateUseNameElementDescriptionFromValue(useNameElementDescriptionValue, partyPK);
163        }
164    }
165    
166}