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.offer.server.command;
018
019import com.echothree.control.user.offer.common.form.GetUseNameElementDescriptionForm;
020import com.echothree.control.user.offer.common.result.OfferResultFactory;
021import com.echothree.control.user.offer.common.result.GetUseNameElementDescriptionResult;
022import com.echothree.model.control.offer.server.control.UseNameElementControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.offer.server.entity.UseNameElement;
028import com.echothree.model.data.offer.server.entity.UseNameElementDescription;
029import com.echothree.model.data.party.server.entity.Language;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class GetUseNameElementDescriptionCommand
045        extends BaseSimpleCommand<GetUseNameElementDescriptionForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.UseNameElement.name(), SecurityRoles.Description.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("UseNameElementName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetUseNameElementDescriptionCommand */
065    public GetUseNameElementDescriptionCommand(UserVisitPK userVisitPK, GetUseNameElementDescriptionForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var useNameElementControl = Session.getModelController(UseNameElementControl.class);
072        GetUseNameElementDescriptionResult result = OfferResultFactory.getGetUseNameElementDescriptionResult();
073        String useNameElementName = form.getUseNameElementName();
074        UseNameElement useNameElement = useNameElementControl.getUseNameElementByName(useNameElementName);
075        
076        if(useNameElement != null) {
077            var partyControl = Session.getModelController(PartyControl.class);
078            String languageIsoName = form.getLanguageIsoName();
079            Language language = partyControl.getLanguageByIsoName(languageIsoName);
080            
081            if(language != null) {
082                UseNameElementDescription useNameElementDescription = useNameElementControl.getUseNameElementDescription(useNameElement, language);
083                
084                if(useNameElementDescription != null) {
085                    result.setUseNameElementDescription(useNameElementControl.getUseNameElementDescriptionTransfer(getUserVisit(), useNameElementDescription));
086                } else {
087                    addExecutionError(ExecutionErrors.UnknownUseNameElementDescription.name(), useNameElementName, languageIsoName);
088                }
089            } else {
090                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
091            }
092        } else {
093            addExecutionError(ExecutionErrors.UnknownUseNameElementName.name(), useNameElementName);
094        }
095        
096        return result;
097    }
098    
099}