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.GetTrackForm;
020import com.echothree.control.user.track.common.result.TrackResultFactory;
021import com.echothree.model.control.core.common.ComponentVendors;
022import com.echothree.model.control.core.common.EntityTypes;
023import com.echothree.model.control.core.common.EventTypes;
024import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.track.server.control.TrackControl;
029import com.echothree.model.data.track.server.entity.Track;
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 java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class GetTrackCommand
045        extends BaseSimpleCommand<GetTrackForm> {
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(List.of(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
054                        new SecurityRoleDefinition(SecurityRoleGroups.Track.name(), SecurityRoles.Review.name())
055                ))
056        ));
057        
058        FORM_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("TrackName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
061                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
062        );
063    }
064
065    @Inject
066    TrackControl trackControl;
067
068    @Inject
069    EntityInstanceLogic entityInstanceLogic;
070
071    
072    /** Creates a new instance of GetTrackCommand */
073    public GetTrackCommand() {
074        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var result = TrackResultFactory.getGetTrackResult();
080        var trackName = form.getTrackName();
081        var parameterCount = (trackName == null ? 0 : 1) + entityInstanceLogic.countPossibleEntitySpecs(form);
082
083        if(parameterCount == 1) {
084            Track track = null;
085
086            if(trackName == null) {
087                var entityInstance = entityInstanceLogic.getEntityInstance(this, form, ComponentVendors.ECHO_THREE.name(),
088                        EntityTypes.Track.name());
089                
090                if(!hasExecutionErrors()) {
091                    track = trackControl.getTrackByEntityInstance(entityInstance);
092                }
093            } else {
094                track = trackControl.getTrackByName(trackName);
095
096                if(track == null) {
097                    addExecutionError(ExecutionErrors.UnknownTrackName.name(), trackName);
098                }
099            }
100
101            if(!hasExecutionErrors()) {
102                result.setTrack(trackControl.getTrackTransfer(getUserVisit(), track));
103                sendEvent(track.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
104            }
105        } else {
106            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
107        }
108        
109        return result;
110    }
111    
112}