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