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.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.track.server.entity.Track;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class SetTrackStatusCommand
041        extends BaseSimpleCommand<SetTrackStatusForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                    new SecurityRoleDefinition(SecurityRoleGroups.TrackStatus.name(), SecurityRoles.Choices.name())
051                    )))
052                )));
053        
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("TrackName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("TrackStatusChoice", FieldType.ENTITY_NAME, true, null, null)
057                ));
058    }
059    
060    /** Creates a new instance of SetTrackStatusCommand */
061    public SetTrackStatusCommand(UserVisitPK userVisitPK, SetTrackStatusForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var trackControl = Session.getModelController(TrackControl.class);
068        String trackName = form.getTrackName();
069        Track track = trackControl.getTrackByName(trackName);
070        
071        if(track != null) {
072            String trackStatusChoice = form.getTrackStatusChoice();
073            
074            TrackLogic.getInstance().setTrackStatus(session, this, track, trackStatusChoice, getPartyPK());
075        } else {
076            addExecutionError(ExecutionErrors.UnknownTrackName.name(), trackName);
077        }
078        
079        return null;
080    }
081    
082}