001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.SetTrackStatusForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.control.track.server.control.TrackControl;
024import com.echothree.model.control.track.server.logic.TrackLogic;
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 java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class SetTrackStatusCommand
040        extends BaseSimpleCommand<SetTrackStatusForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.TrackStatus.name(), SecurityRoles.Choices.name())
050                ))
051        ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("TrackName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("TrackStatusChoice", FieldType.ENTITY_NAME, true, null, null)
056        );
057    }
058
059    @Inject
060    TrackControl trackControl;
061
062    @Inject
063    TrackLogic trackLogic;
064
065    
066    /** Creates a new instance of SetTrackStatusCommand */
067    public SetTrackStatusCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var trackName = form.getTrackName();
074        var track = trackControl.getTrackByName(trackName);
075        
076        if(track != null) {
077            var trackStatusChoice = form.getTrackStatusChoice();
078            
079            trackLogic.setTrackStatus(session, this, track, trackStatusChoice, getPartyPK());
080        } else {
081            addExecutionError(ExecutionErrors.UnknownTrackName.name(), trackName);
082        }
083        
084        return null;
085    }
086    
087}