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.OfferDescriptionEdit;
020import com.echothree.control.user.offer.common.edit.OfferEditFactory;
021import com.echothree.control.user.offer.common.form.EditOfferDescriptionForm;
022import com.echothree.control.user.offer.common.result.EditOfferDescriptionResult;
023import com.echothree.control.user.offer.common.result.OfferResultFactory;
024import com.echothree.control.user.offer.common.spec.OfferDescriptionSpec;
025import com.echothree.model.control.offer.server.control.OfferControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.offer.server.entity.Offer;
031import com.echothree.model.data.offer.server.entity.OfferDescription;
032import com.echothree.model.data.offer.server.value.OfferDescriptionValue;
033import com.echothree.model.data.party.server.entity.Language;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.BaseResult;
039import com.echothree.util.common.command.EditMode;
040import com.echothree.util.server.control.BaseEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.Arrays;
046import java.util.Collections;
047import java.util.List;
048
049public class EditOfferDescriptionCommand
050        extends BaseEditCommand<OfferDescriptionSpec, OfferDescriptionEdit> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                        new SecurityRoleDefinition(SecurityRoleGroups.Offer.name(), SecurityRoles.Description.name())
061                        )))
062                )));
063        
064        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
065                new FieldDefinition("OfferName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
067                ));
068        
069        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
070                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
071                ));
072    }
073    
074    /** Creates a new instance of EditOfferDescriptionCommand */
075    public EditOfferDescriptionCommand(UserVisitPK userVisitPK, EditOfferDescriptionForm form) {
076        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078    
079    @Override
080    protected BaseResult execute() {
081        var offerControl = Session.getModelController(OfferControl.class);
082        EditOfferDescriptionResult result = OfferResultFactory.getEditOfferDescriptionResult();
083        String offerName = spec.getOfferName();
084        Offer offer = offerControl.getOfferByName(offerName);
085        
086        if(offer != null) {
087            var partyControl = Session.getModelController(PartyControl.class);
088            String languageIsoName = spec.getLanguageIsoName();
089            Language language = partyControl.getLanguageByIsoName(languageIsoName);
090            
091            if(language != null) {
092                if(editMode.equals(EditMode.LOCK)) {
093                    OfferDescription offerDescription = offerControl.getOfferDescription(offer, language);
094                    
095                    if(offerDescription != null) {
096                        result.setOfferDescription(offerControl.getOfferDescriptionTransfer(getUserVisit(), offerDescription));
097                        
098                        if(lockEntity(offer)) {
099                            OfferDescriptionEdit edit = OfferEditFactory.getOfferDescriptionEdit();
100                            
101                            result.setEdit(edit);
102                            edit.setDescription(offerDescription.getDescription());
103                        } else {
104                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
105                        }
106                        
107                        result.setEntityLock(getEntityLockTransfer(offer));
108                    } else {
109                        addExecutionError(ExecutionErrors.UnknownOfferDescription.name());
110                    }
111                } else if(editMode.equals(EditMode.UPDATE)) {
112                    OfferDescriptionValue offerDescriptionValue = offerControl.getOfferDescriptionValueForUpdate(offer, language);
113                    
114                    if(offerDescriptionValue != null) {
115                        if(lockEntityForUpdate(offer)) {
116                            try {
117                                String description = edit.getDescription();
118                                
119                                offerDescriptionValue.setDescription(description);
120                                
121                                offerControl.updateOfferDescriptionFromValue(offerDescriptionValue, getPartyPK());
122                            } finally {
123                                unlockEntity(offer);
124                            }
125                        } else {
126                            addExecutionError(ExecutionErrors.EntityLockStale.name());
127                        }
128                    } else {
129                        addExecutionError(ExecutionErrors.UnknownOfferDescription.name());
130                    }
131                }
132            } else {
133                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
134            }
135        } else {
136            addExecutionError(ExecutionErrors.UnknownOfferName.name(), offerName);
137        }
138        
139        return result;
140    }
141    
142}