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.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.Arrays;
039import java.util.Collection;
040import java.util.Collections;
041import java.util.List;
042import javax.enterprise.context.RequestScoped;
043
044@RequestScoped
045public class GetContentPageLayoutsCommand
046        extends BasePaginatedMultipleEntitiesCommand<ContentPageLayout, GetContentPageLayoutsForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.ContentPageLayout.name(), SecurityRoles.List.name())
056                        )))
057                )));
058        
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                ));
061    }
062    
063    /** Creates a new instance of GetContentPageLayoutsCommand */
064    public GetContentPageLayoutsCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067
068    @Override
069    protected void handleForm() {
070        // No form fields.
071    }
072
073    @Override
074    protected Long getTotalEntities() {
075        var contentControl = Session.getModelController(ContentControl.class);
076
077        return contentControl.countContentPageLayouts();
078    }
079
080    @Override
081    protected Collection<ContentPageLayout> getEntities() {
082        var contentControl = Session.getModelController(ContentControl.class);
083
084        return contentControl.getContentPageLayouts();
085    }
086
087    @Override
088    protected BaseResult getResult(Collection<ContentPageLayout> entities) {
089        var result = ContentResultFactory.getGetContentPageLayoutsResult();
090
091        if(entities != null) {
092            var contentControl = Session.getModelController(ContentControl.class);
093
094            if(session.hasLimit(ContentPageLayoutFactory.class)) {
095                result.setContentPageLayoutCount(getTotalEntities());
096            }
097
098            result.setContentPageLayouts(contentControl.getContentPageLayoutTransfers(getUserVisit(), entities));
099        }
100
101        return result;
102    }
103    
104}