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