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.shipment.server.graphql;
018
019import com.echothree.model.control.graphql.server.graphql.BaseEntityInstanceObject;
020import com.echothree.model.control.graphql.server.util.BaseGraphQl;
021import com.echothree.model.control.shipment.server.control.FreeOnBoardControl;
022import com.echothree.model.control.user.server.control.UserControl;
023import com.echothree.model.data.shipment.server.entity.FreeOnBoard;
024import com.echothree.model.data.shipment.server.entity.FreeOnBoardDetail;
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("free on board object")
033@GraphQLName("FreeOnBoard")
034public class FreeOnBoardObject
035        extends BaseEntityInstanceObject {
036    
037    private final FreeOnBoard freeOnBoard; // Always Present
038    
039    public FreeOnBoardObject(FreeOnBoard freeOnBoard) {
040        super(freeOnBoard.getPrimaryKey());
041        
042        this.freeOnBoard = freeOnBoard;
043    }
044
045    private FreeOnBoardDetail freeOnBoardDetail; // Optional, use getFreeOnBoardDetail()
046    
047    private FreeOnBoardDetail getFreeOnBoardDetail() {
048        if(freeOnBoardDetail == null) {
049            freeOnBoardDetail = freeOnBoard.getLastDetail();
050        }
051        
052        return freeOnBoardDetail;
053    }
054    
055    @GraphQLField
056    @GraphQLDescription("free on board name")
057    @GraphQLNonNull
058    public String getFreeOnBoardName() {
059        return getFreeOnBoardDetail().getFreeOnBoardName();
060    }
061
062    @GraphQLField
063    @GraphQLDescription("is default")
064    @GraphQLNonNull
065    public boolean getIsDefault() {
066        return getFreeOnBoardDetail().getIsDefault();
067    }
068    
069    @GraphQLField
070    @GraphQLDescription("sort order")
071    @GraphQLNonNull
072    public int getSortOrder() {
073        return getFreeOnBoardDetail().getSortOrder();
074    }
075    
076    @GraphQLField
077    @GraphQLDescription("description")
078    @GraphQLNonNull
079    public String getDescription(final DataFetchingEnvironment env) {
080        var freeOnBoardControl = Session.getModelController(FreeOnBoardControl.class);
081        var userControl = Session.getModelController(UserControl.class);
082
083        return freeOnBoardControl.getBestFreeOnBoardDescription(freeOnBoard, userControl.getPreferredLanguageFromUserVisit(BaseGraphQl.getUserVisit(env)));
084    }
085    
086}