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.model.control.offer.server.graphql;
018
019import com.echothree.model.control.graphql.server.graphql.BaseEntityInstanceObject;
020import com.echothree.model.control.offer.server.control.UseControl;
021import com.echothree.model.control.graphql.server.util.BaseGraphQl;
022import com.echothree.model.control.user.server.control.UserControl;
023import com.echothree.model.data.offer.server.entity.Use;
024import com.echothree.model.data.offer.server.entity.UseDetail;
025import com.echothree.util.server.persistence.Session;
026import graphql.annotations.annotationTypes.GraphQLDescription;
027import graphql.annotations.annotationTypes.GraphQLField;
028import graphql.annotations.annotationTypes.GraphQLName;
029import graphql.annotations.annotationTypes.GraphQLNonNull;
030import graphql.schema.DataFetchingEnvironment;
031
032@GraphQLDescription("use object")
033@GraphQLName("Use")
034public class UseObject
035        extends BaseEntityInstanceObject {
036    
037    private final Use use; // Always Present
038    
039    public UseObject(Use use) {
040        super(use.getPrimaryKey());
041        
042        this.use = use;
043    }
044
045    private UseDetail useDetail; // Optional, use getUseDetail()
046    
047    private UseDetail getUseDetail() {
048        if(useDetail == null) {
049            useDetail = use.getLastDetail();
050        }
051        
052        return useDetail;
053    }
054    
055    @GraphQLField
056    @GraphQLDescription("use type name")
057    @GraphQLNonNull
058    public String getUseName() {
059        return getUseDetail().getUseName();
060    }
061
062    @GraphQLField
063    @GraphQLDescription("use type")
064    public UseTypeObject getUseType(final DataFetchingEnvironment env) {
065        return OfferSecurityUtils.getHasUseTypeAccess(env) ? new UseTypeObject(getUseDetail().getUseType()) : null;
066    }
067
068    @GraphQLField
069    @GraphQLDescription("is default")
070    @GraphQLNonNull
071    public boolean getIsDefault() {
072        return getUseDetail().getIsDefault();
073    }
074    
075    @GraphQLField
076    @GraphQLDescription("sort order")
077    @GraphQLNonNull
078    public int getSortOrder() {
079        return getUseDetail().getSortOrder();
080    }
081    
082    @GraphQLField
083    @GraphQLDescription("description")
084    @GraphQLNonNull
085    public String getDescription(final DataFetchingEnvironment env) {
086        var useControl = Session.getModelController(UseControl.class);
087        var userControl = Session.getModelController(UserControl.class);
088
089        return useControl.getBestUseDescription(use, userControl.getPreferredLanguageFromUserVisit(BaseGraphQl.getUserVisit(env)));
090    }
091    
092}