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.common;
018
019import com.echothree.control.user.track.common.form.*;
020import com.echothree.control.user.track.common.result.*;
021import com.echothree.model.data.user.common.pk.UserVisitPK;
022import com.echothree.util.common.command.CommandResult;
023import com.echothree.util.common.command.VoidResult;
024
025public interface TrackService
026        extends TrackForms {
027    
028    // -------------------------------------------------------------------------
029    //   Testing
030    // -------------------------------------------------------------------------
031    
032    String ping();
033    
034    // --------------------------------------------------------------------------------
035    //   Tracks
036    // --------------------------------------------------------------------------------
037    
038    CommandResult<CreateTrackResult> createTrack(UserVisitPK userVisitPK, CreateTrackForm form);
039    
040    CommandResult<GetTrackChoicesResult> getTrackChoices(UserVisitPK userVisitPK, GetTrackChoicesForm form);
041    
042    CommandResult<GetTrackResult> getTrack(UserVisitPK userVisitPK, GetTrackForm form);
043    
044    CommandResult<GetTracksResult> getTracks(UserVisitPK userVisitPK, GetTracksForm form);
045    
046    CommandResult<VoidResult> setDefaultTrack(UserVisitPK userVisitPK, SetDefaultTrackForm form);
047    
048    CommandResult<GetTrackStatusChoicesResult> getTrackStatusChoices(UserVisitPK userVisitPK, GetTrackStatusChoicesForm form);
049    
050    CommandResult<VoidResult> setTrackStatus(UserVisitPK userVisitPK, SetTrackStatusForm form);
051    
052    CommandResult<EditTrackResult> editTrack(UserVisitPK userVisitPK, EditTrackForm form);
053    
054    CommandResult<VoidResult> deleteTrack(UserVisitPK userVisitPK, DeleteTrackForm form);
055    
056    // --------------------------------------------------------------------------------
057    //   Track Descriptions
058    // --------------------------------------------------------------------------------
059    
060    CommandResult<VoidResult> createTrackDescription(UserVisitPK userVisitPK, CreateTrackDescriptionForm form);
061    
062    CommandResult<GetTrackDescriptionResult> getTrackDescription(UserVisitPK userVisitPK, GetTrackDescriptionForm form);
063    
064    CommandResult<GetTrackDescriptionsResult> getTrackDescriptions(UserVisitPK userVisitPK, GetTrackDescriptionsForm form);
065    
066    CommandResult<EditTrackDescriptionResult> editTrackDescription(UserVisitPK userVisitPK, EditTrackDescriptionForm form);
067    
068    CommandResult<VoidResult> deleteTrackDescription(UserVisitPK userVisitPK, DeleteTrackDescriptionForm form);
069    
070    // --------------------------------------------------------------------------------
071    //   User Visit Tracks
072    // --------------------------------------------------------------------------------
073    
074    CommandResult<VoidResult> createUserVisitTrack(UserVisitPK userVisitPK, CreateUserVisitTrackForm form);
075    
076}