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.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.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class GetContentCategoryDescriptionsCommand
040        extends BaseSimpleCommand<GetContentCategoryDescriptionsForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.ContentCategory.name(), SecurityRoles.Description.name())
050                        ))
051                ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("ContentCatalogName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ContentCategoryName", FieldType.ENTITY_NAME, true, null, null)
057                );
058    }
059    
060    /** Creates a new instance of GetContentCategoryDescriptionsCommand */
061    public GetContentCategoryDescriptionsCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var contentControl = Session.getModelController(ContentControl.class);
068        var result = ContentResultFactory.getGetContentCategoryDescriptionsResult();
069        var contentCollectionName = form.getContentCollectionName();
070        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
071        
072        if(contentCollection != null) {
073            var contentCatalogName = form.getContentCatalogName();
074            var contentCatalog = contentControl.getContentCatalogByName(contentCollection, contentCatalogName);
075            
076            result.setContentCollection(contentControl.getContentCollectionTransfer(getUserVisit(), contentCollection));
077            
078            if(contentCatalog != null) {
079                var contentCategoryName = form.getContentCategoryName();
080                var contentCategory = contentControl.getContentCategoryByName(contentCatalog, contentCategoryName);
081                
082                result.setContentCatalog(contentControl.getContentCatalogTransfer(getUserVisit(), contentCatalog));
083                
084                if(contentCategory != null) {
085                    result.setContentCategory(contentControl.getContentCategoryTransfer(getUserVisit(), contentCategory));
086                    result.setContentCategoryDescriptions(contentControl.getContentCategoryDescriptionTransfers(getUserVisit(), contentCategory));
087                } else {
088                    addExecutionError(ExecutionErrors.UnknownContentCategoryName.name(), contentCategoryName);
089                }
090            } else {
091                addExecutionError(ExecutionErrors.UnknownContentCatalogName.name(), contentCatalogName);
092            }
093        } else {
094            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
095        }
096        
097        return result;
098    }
099    
100}