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.edit.TrackEdit;
020import com.echothree.control.user.track.common.edit.TrackEditFactory;
021import com.echothree.control.user.track.common.form.EditTrackForm;
022import com.echothree.control.user.track.common.result.EditTrackResult;
023import com.echothree.control.user.track.common.result.TrackResultFactory;
024import com.echothree.control.user.track.common.spec.TrackSpec;
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.EditMode;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
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 EditTrackCommand
045        extends BaseAbstractEditCommand<TrackSpec, TrackEdit, EditTrackResult, Track, Track> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.Track.name(), SecurityRoles.Edit.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("TrackName", FieldType.ENTITY_NAME, true, null, null)
061        );
062        
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("Value", FieldType.STRING, true, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068        );
069    }
070
071    @Inject
072    TrackControl trackControl;
073
074    
075    /** Creates a new instance of EditTrackCommand */
076    public EditTrackCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    public EditTrackResult getResult() {
082        return TrackResultFactory.getEditTrackResult();
083    }
084
085    @Override
086    public TrackEdit getEdit() {
087        return TrackEditFactory.getTrackEdit();
088    }
089
090    @Override
091    public Track getEntity(EditTrackResult result) {
092        Track track;
093        var trackName = spec.getTrackName();
094
095        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
096            track = trackControl.getTrackByName(trackName);
097        } else { // EditMode.UPDATE
098            track = trackControl.getTrackByNameForUpdate(trackName);
099        }
100
101        if(track == null) {
102            addExecutionError(ExecutionErrors.UnknownTrackName.name(), trackName);
103        }
104
105        return track;
106    }
107
108    @Override
109    public Track getLockEntity(Track track) {
110        return track;
111    }
112
113    @Override
114    public void fillInResult(EditTrackResult result, Track track) {
115        result.setTrack(trackControl.getTrackTransfer(getUserVisit(), track));
116    }
117
118    @Override
119    public void doLock(TrackEdit edit, Track track) {
120        var trackDescription = trackControl.getTrackDescription(track, getPreferredLanguage());
121        var trackDetail = track.getLastDetail();
122
123        edit.setValue(trackDetail.getValue());
124        edit.setIsDefault(trackDetail.getIsDefault().toString());
125        edit.setSortOrder(trackDetail.getSortOrder().toString());
126
127        if(trackDescription != null) {
128            edit.setDescription(trackDescription.getDescription());
129        }
130    }
131
132    @Override
133    public void canUpdate(Track track) {
134        var value = edit.getValue();
135        var duplicateTrack = trackControl.getTrackByValue(value);
136
137        if(duplicateTrack != null && !track.equals(duplicateTrack)) {
138            addExecutionError(ExecutionErrors.DuplicateTrackValue.name(), value);
139        }
140    }
141
142    @Override
143    public void doUpdate(Track track) {
144        var partyPK = getPartyPK();
145        var trackDetailValue = trackControl.getTrackDetailValueForUpdate(track);
146        var trackDescription = trackControl.getTrackDescriptionForUpdate(track, getPreferredLanguage());
147        var description = edit.getDescription();
148
149        trackDetailValue.setValue(edit.getValue());
150        trackDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
151        trackDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
152
153        trackControl.updateTrackFromValue(trackDetailValue, partyPK);
154
155        if(trackDescription == null && description != null) {
156            trackControl.createTrackDescription(track, getPreferredLanguage(), description, partyPK);
157        } else {
158            if(trackDescription != null && description == null) {
159                trackControl.deleteTrackDescription(trackDescription, partyPK);
160            } else {
161                if(trackDescription != null && description != null) {
162                    var trackDescriptionValue = trackControl.getTrackDescriptionValue(trackDescription);
163
164                    trackDescriptionValue.setDescription(description);
165                    trackControl.updateTrackDescriptionFromValue(trackDescriptionValue, partyPK);
166                }
167            }
168        }
169    }
170    
171}