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.track.server.command;
018
019import com.echothree.control.user.track.common.form.CreateTrackDescriptionForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.track.server.control.TrackControl;
025import com.echothree.model.data.party.server.entity.Language;
026import com.echothree.model.data.track.server.entity.Track;
027import com.echothree.model.data.track.server.entity.TrackDescription;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class CreateTrackDescriptionCommand
043        extends BaseSimpleCommand<CreateTrackDescriptionForm> {
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.Track.name(), SecurityRoles.Description.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("TrackName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
060                ));
061    }
062    
063    /** Creates a new instance of CreateTrackDescriptionCommand */
064    public CreateTrackDescriptionCommand(UserVisitPK userVisitPK, CreateTrackDescriptionForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var trackControl = Session.getModelController(TrackControl.class);
071        String trackName = form.getTrackName();
072        Track track = trackControl.getTrackByName(trackName);
073        
074        if(track != 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                TrackDescription trackDescription = trackControl.getTrackDescription(track, language);
081                
082                if(trackDescription == null) {
083                    var description = form.getDescription();
084                    
085                    trackControl.createTrackDescription(track, language, description, getPartyPK());
086                } else {
087                    addExecutionError(ExecutionErrors.DuplicateTrackDescription.name(), trackName, languageIsoName);
088                }
089            } else {
090                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
091            }
092        } else {
093            addExecutionError(ExecutionErrors.UnknownTrackName.name(), trackName);
094        }
095        
096        return null;
097    }
098    
099}