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.rating.server.command;
018
019import com.echothree.control.user.rating.common.edit.RatingEdit;
020import com.echothree.control.user.rating.common.edit.RatingEditFactory;
021import com.echothree.control.user.rating.common.form.EditRatingForm;
022import com.echothree.control.user.rating.common.result.RatingResultFactory;
023import com.echothree.control.user.rating.common.spec.RatingSpec;
024import com.echothree.model.control.rating.server.control.RatingControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.command.EditMode;
031import com.echothree.util.server.control.BaseEditCommand;
032import com.echothree.util.server.persistence.Session;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036import javax.enterprise.context.RequestScoped;
037
038@RequestScoped
039public class EditRatingCommand
040        extends BaseEditCommand<RatingSpec, RatingEdit> {
041    
042    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
043    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
044    
045    static {
046        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
047                new FieldDefinition("RatingName", FieldType.ENTITY_NAME, true, null, null)
048                ));
049        
050        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
051                new FieldDefinition("RatingTypeListItemName", FieldType.ENTITY_NAME, true, null, null)
052                ));
053    }
054    
055    /** Creates a new instance of EditRatingCommand */
056    public EditRatingCommand() {
057        super(null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
058    }
059    
060    @Override
061    protected BaseResult execute() {
062        var ratingControl = Session.getModelController(RatingControl.class);
063        var result = RatingResultFactory.getEditRatingResult();
064        var ratingName = spec.getRatingName();
065        var rating = ratingControl.getRatingByName(ratingName);
066
067        if(rating != null) {
068            if(editMode.equals(EditMode.LOCK)) {
069                if(lockEntity(rating)) {
070                    var edit = RatingEditFactory.getRatingEdit();
071                    var ratingDetail = rating.getLastDetail();
072
073                    result.setEdit(edit);
074
075                    edit.setRatingTypeListItemName(ratingDetail.getRatingTypeListItem().getLastDetail().getRatingTypeListItemName());
076                } else {
077                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
078                }
079
080                result.setRating(ratingControl.getRatingTransfer(getUserVisit(), rating));
081                result.setEntityLock(getEntityLockTransfer(rating));
082            } else if(editMode.equals(EditMode.ABANDON)) {
083                unlockEntity(rating);
084            } else if(editMode.equals(EditMode.UPDATE)) {
085                var ratingTypeListItemName = edit.getRatingTypeListItemName();
086                var ratingTypeListItem = ratingControl.getRatingTypeListItemByName(rating.getLastDetail().getRatingTypeListItem().getLastDetail().getRatingType(),
087                        ratingTypeListItemName);
088
089                if(ratingTypeListItem != null) {
090                    if(lockEntityForUpdate(rating)) {
091                        try {
092                            var partyPK = getPartyPK();
093                            var ratingDetailValue = ratingControl.getRatingDetailValueForUpdate(rating);
094
095                            ratingDetailValue.setRatingTypeListItemPK(ratingTypeListItem.getPrimaryKey());
096
097                            ratingControl.updateRatingFromValue(ratingDetailValue, partyPK);
098                        } finally {
099                            unlockEntity(rating);
100                        }
101                    } else {
102                        addExecutionError(ExecutionErrors.EntityLockStale.name());
103                    }
104                } else {
105                    addExecutionError(ExecutionErrors.UnknownRatingTypeListItemName.name(), ratingTypeListItemName);
106                }
107                
108                if(hasExecutionErrors()) {
109                    result.setRating(ratingControl.getRatingTransfer(getUserVisit(), rating));
110                    result.setEntityLock(getEntityLockTransfer(rating));
111                }
112            }
113        } else {
114            addExecutionError(ExecutionErrors.UnknownRatingName.name(), ratingName);
115        }
116
117        return result;
118    }
119    
120}