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.GetContentCategoryDescriptionForm;
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.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetContentCategoryDescriptionCommand
041        extends BaseSimpleCommand<GetContentCategoryDescriptionForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.ContentCategory.name(), SecurityRoles.Description.name())
051                        ))
052                ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ContentCatalogName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ContentCategoryName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
059                );
060    }
061    
062    /** Creates a new instance of GetContentCategoryDescriptionCommand */
063    public GetContentCategoryDescriptionCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var result = ContentResultFactory.getGetContentCategoryDescriptionResult();
070        var contentControl = Session.getModelController(ContentControl.class);
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            if(contentCatalog != null) {
079                var contentCategoryName = form.getContentCategoryName();
080                var contentCategory = contentControl.getContentCategoryByName(contentCatalog, contentCategoryName);
081                
082                if(contentCategory != null) {
083                    var partyControl = Session.getModelController(PartyControl.class);
084                    var languageIsoName = form.getLanguageIsoName();
085                    var language = partyControl.getLanguageByIsoName(languageIsoName);
086                    
087                    if(language != null) {
088                        var contentCategoryDescription = contentControl.getContentCategoryDescription(contentCategory, language);
089                        
090                        if(contentCategoryDescription != null) {
091                            result.setContentCategoryDescription(contentControl.getContentCategoryDescriptionTransfer(getUserVisit(), contentCategoryDescription));
092                        } else {
093                            addExecutionError(ExecutionErrors.UnknownContentCategoryDescription.name(), contentCollectionName, contentCatalogName, contentCategoryName,
094                                    languageIsoName);
095                        }
096                    } else {
097                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
098                    }
099                } else {
100                    addExecutionError(ExecutionErrors.UnknownContentCategoryName.name(), contentCollectionName, contentCatalogName, contentCategoryName);
101                }
102            } else {
103                addExecutionError(ExecutionErrors.UnknownContentCatalogName.name(), contentCollectionName, contentCatalogName);
104            }
105        } else {
106            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
107        }
108        
109        return result;
110    }
111    
112}