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.core.server.command;
018
019import com.echothree.control.user.core.common.form.GetAppearanceDescriptionForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.control.user.core.common.result.GetAppearanceDescriptionResult;
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.core.server.entity.Appearance;
027import com.echothree.model.data.core.server.entity.AppearanceDescription;
028import com.echothree.model.data.party.server.entity.Language;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class GetAppearanceDescriptionCommand
044        extends BaseSimpleCommand<GetAppearanceDescriptionForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.Appearance.name(), SecurityRoles.Description.name())
054                        )))
055                )));
056        
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("AppearanceName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetAppearanceDescriptionCommand */
063    public GetAppearanceDescriptionCommand(UserVisitPK userVisitPK, GetAppearanceDescriptionForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var coreControl = getCoreControl();
070        GetAppearanceDescriptionResult result = CoreResultFactory.getGetAppearanceDescriptionResult();
071        String appearanceName = form.getAppearanceName();
072        Appearance appearance = coreControl.getAppearanceByName(appearanceName);
073
074        if(appearance != null) {
075            var partyControl = Session.getModelController(PartyControl.class);
076            String languageIsoName = form.getLanguageIsoName();
077            Language language = partyControl.getLanguageByIsoName(languageIsoName);
078
079            if(language != null) {
080                AppearanceDescription appearanceDescription = coreControl.getAppearanceDescription(appearance, language);
081
082                if(appearanceDescription != null) {
083                    result.setAppearanceDescription(coreControl.getAppearanceDescriptionTransfer(getUserVisit(), appearanceDescription));
084                } else {
085                    addExecutionError(ExecutionErrors.UnknownAppearanceDescription.name(), appearanceName, languageIsoName);
086                }
087            } else {
088                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
089            }
090        } else {
091            addExecutionError(ExecutionErrors.UnknownAppearanceName.name(), appearanceName);
092        }
093
094        return result;
095    }
096    
097}