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.control.user.content.server.command;
018
019import com.echothree.control.user.content.common.form.GetContentPageLayoutsForm;
020import com.echothree.control.user.content.common.result.ContentResultFactory;
021import com.echothree.model.control.content.server.control.ContentControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.content.server.entity.ContentPageAreaType;
026import com.echothree.model.data.content.server.entity.ContentPageLayout;
027import com.echothree.model.data.content.server.factory.ContentPageAreaTypeFactory;
028import com.echothree.model.data.content.server.factory.ContentPageLayoutFactory;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
033import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Collection;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041
042@Dependent
043public class GetContentPageLayoutsCommand
044        extends BasePaginatedMultipleEntitiesCommand<ContentPageLayout, GetContentPageLayoutsForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.ContentPageLayout.name(), SecurityRoles.List.name())
054                        ))
055                ));
056        
057        FORM_FIELD_DEFINITIONS = List.of(
058                );
059    }
060    
061    /** Creates a new instance of GetContentPageLayoutsCommand */
062    public GetContentPageLayoutsCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066    @Override
067    protected void handleForm() {
068        // No form fields.
069    }
070
071    @Override
072    protected Long getTotalEntities() {
073        var contentControl = Session.getModelController(ContentControl.class);
074
075        return contentControl.countContentPageLayouts();
076    }
077
078    @Override
079    protected Collection<ContentPageLayout> getEntities() {
080        var contentControl = Session.getModelController(ContentControl.class);
081
082        return contentControl.getContentPageLayouts();
083    }
084
085    @Override
086    protected BaseResult getResult(Collection<ContentPageLayout> entities) {
087        var result = ContentResultFactory.getGetContentPageLayoutsResult();
088
089        if(entities != null) {
090            var contentControl = Session.getModelController(ContentControl.class);
091
092            if(session.hasLimit(ContentPageLayoutFactory.class)) {
093                result.setContentPageLayoutCount(getTotalEntities());
094            }
095
096            result.setContentPageLayouts(contentControl.getContentPageLayoutTransfers(getUserVisit(), entities));
097        }
098
099        return result;
100    }
101    
102}