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