001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.content.server.command;
018
019import com.echothree.control.user.content.common.form.CreateContentPageLayoutAreaForm;
020import com.echothree.model.control.content.server.control.ContentControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class CreateContentPageLayoutAreaCommand
041        extends BaseSimpleCommand<CreateContentPageLayoutAreaForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.ContentPageLayoutArea.name(), SecurityRoles.Create.name())
051                        )))
052                )));
053        
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("ContentPageLayoutName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ContentPageAreaTypeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ShowDescriptionField", FieldType.BOOLEAN, true, null, null),
058                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of CreateContentPageLayoutAreaCommand */
063    public CreateContentPageLayoutAreaCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var contentControl = Session.getModelController(ContentControl.class);
070        var contentPageLayoutName = form.getContentPageLayoutName();
071        var contentPageLayout = contentControl.getContentPageLayoutByName(contentPageLayoutName);
072        
073        if(contentPageLayout != null) {
074            var sortOrder = Integer.valueOf(form.getSortOrder());
075            var contentPageLayoutArea = contentControl.getContentPageLayoutArea(contentPageLayout, sortOrder);
076            
077            if(contentPageLayoutArea == null) {
078                var showDescriptionField = Boolean.valueOf(form.getShowDescriptionField());
079                var contentPageAreaTypeName = form.getContentPageAreaTypeName();
080                var contentPageAreaType = contentControl.getContentPageAreaTypeByName(contentPageAreaTypeName);
081                
082                contentControl.createContentPageLayoutArea(contentPageLayout, contentPageAreaType, showDescriptionField, sortOrder);
083            } else {
084                addExecutionError(ExecutionErrors.DuplicateContentPageLayoutArea.name());
085            }
086        } else {
087            addExecutionError(ExecutionErrors.UnknownContentPageLayoutName.name(), contentPageLayoutName);
088        }
089        
090        return null;
091    }
092    
093}