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.core.server.command;
018
019import com.echothree.control.user.core.common.form.GetApplicationDescriptionForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.ApplicationControl;
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.command.BaseResult;
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.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.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetApplicationDescriptionCommand
043        extends BaseSimpleCommand<GetApplicationDescriptionForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.Application.name(), SecurityRoles.Description.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("ApplicationName", FieldType.ENTITY_NAME, true, null, null)
058                ));
059    }
060    
061    /** Creates a new instance of GetApplicationDescriptionCommand */
062    public GetApplicationDescriptionCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var applicationControl = Session.getModelController(ApplicationControl.class);
069        var result = CoreResultFactory.getGetApplicationDescriptionResult();
070        var applicationName = form.getApplicationName();
071        var application = applicationControl.getApplicationByName(applicationName);
072
073        if(application != null) {
074            var partyControl = Session.getModelController(PartyControl.class);
075            var languageIsoName = form.getLanguageIsoName();
076            var language = partyControl.getLanguageByIsoName(languageIsoName);
077
078            if(language != null) {
079                var applicationDescription = applicationControl.getApplicationDescription(application, language);
080
081                if(applicationDescription != null) {
082                    result.setApplicationDescription(applicationControl.getApplicationDescriptionTransfer(getUserVisit(), applicationDescription));
083                } else {
084                    addExecutionError(ExecutionErrors.UnknownApplicationDescription.name(), applicationName, languageIsoName);
085                }
086            } else {
087                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
088            }
089        } else {
090            addExecutionError(ExecutionErrors.UnknownApplicationName.name(), applicationName);
091        }
092
093        return result;
094    }
095    
096}