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.GetContentCategoryDescriptionsForm;
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.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetContentCategoryDescriptionsCommand
042        extends BaseSimpleCommand<GetContentCategoryDescriptionsForm> {
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.ContentCategory.name(), SecurityRoles.Description.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("ContentCatalogName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ContentCategoryName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetContentCategoryDescriptionsCommand */
063    public GetContentCategoryDescriptionsCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var contentControl = Session.getModelController(ContentControl.class);
070        var result = ContentResultFactory.getGetContentCategoryDescriptionsResult();
071        var contentCollectionName = form.getContentCollectionName();
072        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
073        
074        if(contentCollection != null) {
075            var contentCatalogName = form.getContentCatalogName();
076            var contentCatalog = contentControl.getContentCatalogByName(contentCollection, contentCatalogName);
077            
078            result.setContentCollection(contentControl.getContentCollectionTransfer(getUserVisit(), contentCollection));
079            
080            if(contentCatalog != null) {
081                var contentCategoryName = form.getContentCategoryName();
082                var contentCategory = contentControl.getContentCategoryByName(contentCatalog, contentCategoryName);
083                
084                result.setContentCatalog(contentControl.getContentCatalogTransfer(getUserVisit(), contentCatalog));
085                
086                if(contentCategory != null) {
087                    result.setContentCategory(contentControl.getContentCategoryTransfer(getUserVisit(), contentCategory));
088                    result.setContentCategoryDescriptions(contentControl.getContentCategoryDescriptionTransfers(getUserVisit(), contentCategory));
089                } else {
090                    addExecutionError(ExecutionErrors.UnknownContentCategoryName.name(), contentCategoryName);
091                }
092            } else {
093                addExecutionError(ExecutionErrors.UnknownContentCatalogName.name(), contentCatalogName);
094            }
095        } else {
096            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
097        }
098        
099        return result;
100    }
101    
102}