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.model.control.content.server.graphql;
018
019import com.echothree.model.control.content.server.control.ContentControl;
020import com.echothree.model.control.graphql.server.graphql.BaseEntityInstanceObject;
021import com.echothree.model.control.graphql.server.util.BaseGraphQl;
022import com.echothree.model.control.user.server.control.UserControl;
023import com.echothree.model.data.content.server.entity.ContentPageLayoutArea;
024import com.echothree.util.server.persistence.Session;
025import graphql.annotations.annotationTypes.GraphQLDescription;
026import graphql.annotations.annotationTypes.GraphQLField;
027import graphql.annotations.annotationTypes.GraphQLName;
028import graphql.annotations.annotationTypes.GraphQLNonNull;
029import graphql.schema.DataFetchingEnvironment;
030
031@GraphQLDescription("content page layout area")
032@GraphQLName("ContentPageLayoutArea")
033public class ContentPageLayoutAreaObject
034        extends BaseEntityInstanceObject {
035    
036    private final ContentPageLayoutArea contentPageLayoutArea; // Always Present
037    
038    public ContentPageLayoutAreaObject(ContentPageLayoutArea contentPageLayoutArea) {
039        super(contentPageLayoutArea.getPrimaryKey());
040        
041        this.contentPageLayoutArea = contentPageLayoutArea;
042    }
043
044    @GraphQLField
045    @GraphQLDescription("content page layout")
046    public ContentPageLayoutObject getContentPageLayout(final DataFetchingEnvironment env) {
047        return ContentSecurityUtils.getHasContentPageLayoutAccess(env) ? new ContentPageLayoutObject(contentPageLayoutArea.getContentPageLayout()) : null;
048    }
049
050    @GraphQLField
051    @GraphQLDescription("content page area type")
052    @GraphQLNonNull
053    public ContentPageAreaTypeObject getContentPageAreaType(final DataFetchingEnvironment env) {
054        return new ContentPageAreaTypeObject(contentPageLayoutArea.getContentPageAreaType());
055    }
056
057    @GraphQLField
058    @GraphQLDescription("show description field")
059    @GraphQLNonNull
060    public boolean getShowDescriptionField() {
061        return contentPageLayoutArea.getShowDescriptionField();
062    }
063
064    @GraphQLField
065    @GraphQLDescription("sort order")
066    @GraphQLNonNull
067    public int getSortOrder() {
068        return contentPageLayoutArea.getSortOrder();
069    }
070    
071    @GraphQLField
072    @GraphQLDescription("description")
073    @GraphQLNonNull
074    public String getDescription(final DataFetchingEnvironment env) {
075        var contentControl = Session.getModelController(ContentControl.class);
076        var userControl = Session.getModelController(UserControl.class);
077
078        return contentControl.getBestContentPageLayoutAreaDescription(contentPageLayoutArea, userControl.getPreferredLanguageFromUserVisit(BaseGraphQl.getUserVisit(env)));
079    }
080    
081}