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.offer.server.command;
018
019import com.echothree.control.user.offer.common.form.CreateUseDescriptionForm;
020import com.echothree.model.control.offer.server.control.UseControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
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.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class CreateUseDescriptionCommand
042        extends BaseSimpleCommand<CreateUseDescriptionForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Use.name(), SecurityRoles.Description.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("UseName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
059                ));
060    }
061    
062    /** Creates a new instance of CreateUseDescriptionCommand */
063    public CreateUseDescriptionCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var useName = form.getUseName();
070        var useControl = Session.getModelController(UseControl.class);
071        var use = useControl.getUseByName(useName);
072        
073        if(use != null) {
074            var partyControl = Session.getModelController(PartyControl.class);
075            var languageIsoName = form.getLanguageIsoName();
076            var language = partyControl.getLanguageByIsoName(languageIsoName);
077            if(language != null) {
078                var useDescription = useControl.getUseDescription(use, language);
079                
080                if(useDescription == null) {
081                    var description = form.getDescription();
082                    
083                    useControl.createUseDescription(use, language, description, getPartyPK());
084                } else {
085                    addExecutionError(ExecutionErrors.DuplicateUseDescription.name());
086                }
087            } else {
088                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
089            }
090        } else {
091            addExecutionError(ExecutionErrors.UnknownUseName.name(), useName);
092        }
093        
094        return null;
095    }
096    
097}