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.form.GetRatingForm;
020import com.echothree.control.user.rating.common.result.RatingResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.rating.server.control.RatingControl;
023import com.echothree.model.control.rating.server.logic.RatingLogic;
024import com.echothree.model.data.rating.server.entity.Rating;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSingleEntityCommand;
029import java.util.List;
030import javax.enterprise.context.Dependent;
031import javax.inject.Inject;
032
033@Dependent
034public class GetRatingCommand
035        extends BaseSingleEntityCommand<Rating, GetRatingForm> {
036    
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("RatingName", FieldType.ENTITY_NAME, true, null, null)
042        );
043    }
044
045    @Inject
046    RatingControl ratingControl;
047
048    @Inject
049    RatingLogic ratingLogic;
050    
051    /** Creates a new instance of GetRatingCommand */
052    public GetRatingCommand() {
053        super(null, FORM_FIELD_DEFINITIONS, true);
054    }
055    
056    @Override
057    protected Rating getEntity() {
058        var rating = ratingLogic.getRatingByName(this, form.getRatingName());
059
060        if(rating != null) {
061            sendEvent(rating.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
062        }
063
064        return rating;
065    }
066
067    @Override
068    protected BaseResult getResult(Rating rating) {
069        var result = RatingResultFactory.getGetRatingResult();
070
071        if(rating != null) {
072            result.setRating(ratingControl.getRatingTransfer(getUserVisit(), rating));
073        }
074
075        return result;
076    }
077    
078}