General Planning Implementation task of Managing Play List in Chinook

[jthompsonnait]

This task list will be completed once the implementation plan has been outlined. This area is where one creates the task list that is associated with the milestone.

• [ ] Create Data Model
  • Create Query Models
  • [ ] ViewModel -> TrackSelectionView
  • [ ] ViewModel -> PlaylistTrackView
  • Create Command Models
  • [ ] ViewModel -> MoveTrackModel
  • [ ] Create Transactional Services (methods)
  • [ ] Add a track (AddTrack)
  • [ ] Remove tracks from playlist (RemoveTracks)
  • [ ] Reorganize playlist tracks (MoveTracks)
  • [ ] #4

[jthompsonnait]

UI Experience

This comment outlines the actions that can happen on the forms. Actions are in response to the user interacting with the form, pressing buttons or controls.

PRG Post Redirect Get (Query)

• Using routing parameters {searchType?}/{searchValue?}/{playlistName?}
• PRG clicking the Clear empties bound properties and routing parameters (page only)
• PRG clicking the Fetch List will retrieve the existing playlist for the specified playlist name {playlistName?}
  • rule: playlist name cannot be empty
  • rule: playlist must exist in the database
• PRG clicking the Fetch Artist tracks or Fetch Album tracks will retrieve the tracks for the indicated search and display in a table {searchType?}/{searchValue?}
  • rule: search value cannot be empty
• Post/PRG clicking the Add [+] on the track will attempt to add the track to the playlist: <<< AddTrack >>>
  • rule: unique track on the playlist
  • rule: playlist name needs to be unique for the user
  • rule: appended track to playlist
• Post/PRG clicking the Remove Tracks will attempt to remove one or more tracks from the playlist: <<< RemoveTrack >>>
  • rule: re-sequence the playlist track number leaving no gaps
• Post/PRG clicking the Re-Org tracks will reorder the tracks based on the values that are in the edit box: <<< MoveTrack >>>
  • rule: only one track can be changed at a time
  • rule: numbers must be in the current ranges of known tracks.

  • rule: numbers must be unique (no repeating track numbers)

[jthompsonnait]

Data Models

The data models are the C# classes that will be coded in the folder (ViewModels) that holds the data classes in our solution. These classes represent the query class models and the command class models (CQRS - Command and Query Responsibility Segregation pattern).

Query Models

Artist and Album Track Fetch

public class TrackSelectionView
{
        public int TrackId { get; set; }
        public string SongName { get; set; }
        public string AlbumTitle { get; set; }
        public string ArtistName { get; set; }
        public int Milliseconds { get; set; }
        public decimal Price { get; set; }
        public string Length
        {
            get { return $"{(int)Milliseconds / 60 / 1000}:{Milliseconds / 1000 % 60}"; }
        }
}

Current Playlist Tracks

public class PlaylistTrackView
{
        public int TrackId { get; set; }
        public bool Remove { get; set; }
        public int TrackNumber { get; set; }
        public string SongName { get; set; }
        public int Milliseconds { get; set; }
        public string Length
        {
            get { return $"{(int)Milliseconds / 60 / 1000}:{Milliseconds / 1000 % 60}"; }
        }
        public int NewTrackNumber { get; set; }
}

Command Models

Add Track

No model class, individual parameters public void AddTrack(string userName, string playlistName, int trackId)

Remove Track

No model class, individual parameters

public void RemoveTracks(int playListId, list<int> trackIds)

Move Track

public class MoveTrackView
{
  public int TrackId {get; set;}
  public int TrackNumber {get; set;}
}

[jthompsonnait]

Business Processing Requirements

This comment will describe the various methods that will be used for Commands (CQRS) that alter the database. Queries are read-only and require on average no complex processing. You may in another comment, outline your query methods. However, commands require business rules, data validation and manipulations of one or more tables and/or records. Therefore, the processing of commands could require extensive logic to be outlined.

Include the method signature and a bullet list of processing (pseido code)

Fetch Playlist

List<PlaylistTrackView> PlaylistTrackServices_FetchPlaylist(string userName, string playlistName)

• check if the playlist name exists

  • no (empty playlist name)
  • empty playlist name, throw NullArgumentException
  • yes (playlist name exists)
  • check if the playlist exists in the database
    • no (no playlist found)
    • empty playlist, throw NullArgumentException
    • yes

    • return the playlist

      Fetch Artist or Album Tracks

      list<TrackSelectionView> PlaylistTrackServices_FetchArtistOrAlbumTracks(string searchType, string searchValue)

• check if the searchValue exists

  • no (empty searchValue)
  • does not exist, throw NullArgumentException for search value
  • yes (searchValueexists)

  • return the selected tracks for either artist or albums

    Add Track

    void PlaylistTrackServices_AddTrack(string userName, string playlistName, int trackId)

• check if the incoming data is complete (all parameter exists)

  • if a problem exists, throw an ArgumentNullException for missing incoming values.

• check that the trackId exists

  • does not exist, throw ArgumentException on TrackId

• check to see if the playlist exists

  • no (new playlist)
  • create a new playlist
  • set track number to 1
  • yes (append to existing playlist)
  • check if the track already exists on the playlist
    • yes
    • throw an Exception that track already exists
    • no
    • determine the next track number

• add track to playlist tracks

• check for any errors

  • yes: throw the list of all collected exceptions

  • no: save all work to the database

    Remove Track(s)

    void PlaylistTrackServices_RemoveTracks(int playlistId, list<int> trackIds)

• check if the incoming data is complete (all parameter exists)

  • if a problem exists, throw an ArgumentNullException for missing incoming values.

• check that the playlistId exists

  • does not exist, throw ArgumentException on playlistId

• yes

  • for each track to be removed
  • check that the track exists
    • yes: remove the track
    • no: add track id to the exception list
  • for each track that exists on the playlist tracks
    • re-sequence the tracking number (starting at 1, increment by 1)
    • stage each track for update

• check for any errors

  • yes: throw the list of all collected exceptions
  • no: save all the tracks to the database

---

Move Track

void PlaylistTrackServices_MoveTrack(int playlistId, List<MoveTrackView> moveTracks)

• check if the incoming data is complete (all parameter exists)
  • if a problem exists, throw an ArgumentNullException for missing incoming values.
• check that the playlistId exists
  • does not exist, throw ArgumentException on playlistId
• yes
  • check tracks to be move
  • for each track:
    • track number is positive numeric (add any exception)
    • track number is unique (add any exception)
  • for each track:
    • re-sequence track number (start 1, increment by 1)
    • Stage update
• check for any exception
  • yes: throw new exception list
  • no: save all staged work