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.GetContentSectionChoicesForm;
020import com.echothree.control.user.content.common.result.ContentResultFactory;
021import com.echothree.control.user.content.common.result.GetContentSectionChoicesResult;
022import com.echothree.model.control.content.server.control.ContentControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.content.server.entity.ContentCollection;
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 GetContentSectionChoicesCommand
042        extends BaseSimpleCommand<GetContentSectionChoicesForm> {
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.ContentSection.name(), SecurityRoles.Choices.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("DefaultItemAccountingCategoryChoice", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetContentSectionChoicesCommand */
063    public GetContentSectionChoicesCommand(UserVisitPK userVisitPK, GetContentSectionChoicesForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var contentControl = Session.getModelController(ContentControl.class);
070        GetContentSectionChoicesResult result = ContentResultFactory.getGetContentSectionChoicesResult();
071        String contentCollectionName = form.getContentCollectionName();
072        ContentCollection contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
073        
074        if(contentCollection != null) {
075            String defaultContentSectionChoice = form.getDefaultContentSectionChoice();
076            boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
077
078            result.setContentSectionChoices(contentControl.getContentSectionChoices(contentCollection, defaultContentSectionChoice, getPreferredLanguage(), allowNullChoice));
079        } else {
080            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
081        }
082        
083        return result;
084    }
085    
086}