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