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.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.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
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 EditUseNameElementCommand
047        extends BaseAbstractEditCommand<UseNameElementUniversalSpec, UseNameElementEdit, EditUseNameElementResult, UseNameElement, UseNameElement> {
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.UseNameElement.name(), SecurityRoles.Edit.name())
058                        )))
059                )));
060        
061        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("UseNameElementName", FieldType.ENTITY_NAME, false, null, null),
063                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
064                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
065                ));
066        
067        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("UseNameElementName", FieldType.ENTITY_NAME, true, null, null),
069                new FieldDefinition("Offset", FieldType.UNSIGNED_INTEGER, true, null, null),
070                new FieldDefinition("Length", FieldType.UNSIGNED_INTEGER, true, null, null),
071                new FieldDefinition("ValidationPattern", FieldType.REGULAR_EXPRESSION, false, null, null),
072                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
073                ));
074    }
075    
076    /** Creates a new instance of EditUseNameElementCommand */
077    public EditUseNameElementCommand() {
078        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
079    }
080    
081    @Override
082    public EditUseNameElementResult getResult() {
083        return OfferResultFactory.getEditUseNameElementResult();
084    }
085    
086    @Override
087    public UseNameElementEdit getEdit() {
088        return OfferEditFactory.getUseNameElementEdit();
089    }
090    
091    @Override
092    public UseNameElement getEntity(EditUseNameElementResult result) {
093        return UseNameElementLogic.getInstance().getUseNameElementByUniversalSpec(this, spec, editModeToEntityPermission(editMode));
094    }
095    
096    @Override
097    public UseNameElement getLockEntity(UseNameElement useNameElement) {
098        return useNameElement;
099    }
100    
101    @Override
102    public void fillInResult(EditUseNameElementResult result, UseNameElement useNameElement) {
103        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
104        
105        result.setUseNameElement(useNameElementControl.getUseNameElementTransfer(getUserVisit(), useNameElement));
106    }
107    
108    @Override
109    public void doLock(UseNameElementEdit edit, UseNameElement useNameElement) {
110        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
111        var useNameElementDescription = useNameElementControl.getUseNameElementDescription(useNameElement, getPreferredLanguage());
112        var useNameElementDetail = useNameElement.getLastDetail();
113        
114        edit.setUseNameElementName(useNameElementDetail.getUseNameElementName());
115        edit.setOffset(useNameElementDetail.getOffset().toString());
116        edit.setLength(useNameElementDetail.getLength().toString());
117        edit.setValidationPattern(useNameElementDetail.getValidationPattern());
118
119        if(useNameElementDescription != null) {
120            edit.setDescription(useNameElementDescription.getDescription());
121        }
122    }
123        
124    @Override
125    public void canUpdate(UseNameElement useNameElement) {
126        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
127        var useNameElementName = edit.getUseNameElementName();
128        var duplicateUseNameElement = useNameElementControl.getUseNameElementByName(useNameElementName);
129
130        if(duplicateUseNameElement != null && !useNameElement.equals(duplicateUseNameElement)) {
131            addExecutionError(ExecutionErrors.DuplicateUseNameElementName.name(), useNameElementName);
132        }
133    }
134    
135    @Override
136    public void doUpdate(UseNameElement useNameElement) {
137        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
138        var partyPK = getPartyPK();
139        var useNameElementDetailValue = useNameElementControl.getUseNameElementDetailValueForUpdate(useNameElement);
140        var useNameElementDescription = useNameElementControl.getUseNameElementDescriptionForUpdate(useNameElement, getPreferredLanguage());
141        var description = edit.getDescription();
142
143        useNameElementDetailValue.setUseNameElementName(edit.getUseNameElementName());
144        useNameElementDetailValue.setOffset(Integer.valueOf(edit.getOffset()));
145        useNameElementDetailValue.setLength(Integer.valueOf(edit.getLength()));
146        useNameElementDetailValue.setValidationPattern(edit.getValidationPattern());
147
148        useNameElementControl.updateUseNameElementFromValue(useNameElementDetailValue, partyPK);
149
150        if(useNameElementDescription == null && description != null) {
151            useNameElementControl.createUseNameElementDescription(useNameElement, getPreferredLanguage(), description, partyPK);
152        } else if(useNameElementDescription != null && description == null) {
153            useNameElementControl.deleteUseNameElementDescription(useNameElementDescription, partyPK);
154        } else if(useNameElementDescription != null && description != null) {
155            var useNameElementDescriptionValue = useNameElementControl.getUseNameElementDescriptionValue(useNameElementDescription);
156
157            useNameElementDescriptionValue.setDescription(description);
158            useNameElementControl.updateUseNameElementDescriptionFromValue(useNameElementDescriptionValue, partyPK);
159        }
160    }
161    
162}