PlannedExerciseSessionRecord
  public
  
  final
  
  class
  PlannedExerciseSessionRecord
  
  
  
  
  
  
  
    extends IntervalRecord
  
  
  
  
  
  
  
    
  Captures a planned exercise session, also commonly referred to as a training plan.
 
Each record contains a start time, end time, an exercise type and a list of PlannedExerciseBlock which describe the details of the planned session. The start and end times
 may be in the future.
Summary
| Nested classes | 
|---|
  
    
      | 
        
        
        
        
        class | PlannedExerciseSessionRecord.BuilderBuilder class for PlannedExerciseSessionRecord. | 
    
    
| Inherited methods | 
|---|
|  | 
|  | 
| 
    From class
      
        
          java.lang.Object
        
      
      
  
  
  
    | 
        
        
        
        
        
        Object | 
      clone()
      Creates and returns a copy of this object.
        
    
 |  
  
  
    | 
        
        
        
        
        
        boolean | 
      equals(Object obj)
      Indicates whether some other object is "equal to" this one.
        
    
 |  
  
  
    | 
        
        
        
        
        
        void | 
      finalize()
      Called by the garbage collector on an object when garbage collection
 determines that there are no more references to the object.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        Class<?> | 
      getClass()
      Returns the runtime class of this Object. |  
  
  
    | 
        
        
        
        
        
        int | 
      hashCode()
      Returns a hash code value for the object.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      notify()
      Wakes up a single thread that is waiting on this object's
 monitor.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      notifyAll()
      Wakes up all threads that are waiting on this object's monitor.
        
    
 |  
  
  
    | 
        
        
        
        
        
        String | 
      toString()
      Returns a string representation of the object.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      wait(long timeoutMillis, int nanos)
      Causes the current thread to wait until it is awakened, typically
 by being notified or interrupted, or until a
 certain amount of real time has elapsed.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      wait(long timeoutMillis)
      Causes the current thread to wait until it is awakened, typically
 by being notified or interrupted, or until a
 certain amount of real time has elapsed.
        
    
 |  
  
  
    | 
        
        
        
        final
        
        void | 
      wait()
      Causes the current thread to wait until it is awakened, typically
 by being notified or interrupted.
        
    
 |  | 
Public methods
    equals
    
public boolean equals (Object o)
    
    
    
  Indicates whether some other object is "equal to" this one.
    
    | Parameters | 
|---|
      
        | o | Object: This value may benull. | 
    
    
      | Returns | 
|---|
      
        | boolean | trueif this object is the same as the obj | 
    
 
    getCompletedExerciseSessionId
    
public String getCompletedExerciseSessionId ()
    
    
    
  Returns the id of exercise session that completed this planned session. Returns null if none
 exists.
    
 
    getDuration
    
public Duration getDuration ()
    
    
    
  Returns the expected duration of the planned session.
    
      | Returns | 
|---|
      
        | Duration | This value cannot be null. | 
    
 
    getExerciseType
    
public int getExerciseType ()
    
    
    
  Returns the exercise type of this planned session.
    
      | Returns | 
|---|
      
        | int | Value is ExerciseSessionType.EXERCISE_SESSION_TYPE_UNKNOWN,ExerciseSessionType.EXERCISE_SESSION_TYPE_BADMINTON,ExerciseSessionType.EXERCISE_SESSION_TYPE_BASEBALL,ExerciseSessionType.EXERCISE_SESSION_TYPE_BASKETBALL,ExerciseSessionType.EXERCISE_SESSION_TYPE_BIKING,ExerciseSessionType.EXERCISE_SESSION_TYPE_BIKING_STATIONARY,ExerciseSessionType.EXERCISE_SESSION_TYPE_BOOT_CAMP,ExerciseSessionType.EXERCISE_SESSION_TYPE_BOXING,ExerciseSessionType.EXERCISE_SESSION_TYPE_CALISTHENICS,ExerciseSessionType.EXERCISE_SESSION_TYPE_CRICKET,ExerciseSessionType.EXERCISE_SESSION_TYPE_DANCING,ExerciseSessionType.EXERCISE_SESSION_TYPE_ELLIPTICAL,ExerciseSessionType.EXERCISE_SESSION_TYPE_EXERCISE_CLASS,ExerciseSessionType.EXERCISE_SESSION_TYPE_FENCING,ExerciseSessionType.EXERCISE_SESSION_TYPE_FOOTBALL_AMERICAN,ExerciseSessionType.EXERCISE_SESSION_TYPE_FOOTBALL_AUSTRALIAN,ExerciseSessionType.EXERCISE_SESSION_TYPE_FRISBEE_DISC,ExerciseSessionType.EXERCISE_SESSION_TYPE_GOLF,ExerciseSessionType.EXERCISE_SESSION_TYPE_GUIDED_BREATHING,ExerciseSessionType.EXERCISE_SESSION_TYPE_GYMNASTICS,ExerciseSessionType.EXERCISE_SESSION_TYPE_HANDBALL,ExerciseSessionType.EXERCISE_SESSION_TYPE_HIGH_INTENSITY_INTERVAL_TRAINING,ExerciseSessionType.EXERCISE_SESSION_TYPE_HIKING,ExerciseSessionType.EXERCISE_SESSION_TYPE_ICE_HOCKEY,ExerciseSessionType.EXERCISE_SESSION_TYPE_ICE_SKATING,ExerciseSessionType.EXERCISE_SESSION_TYPE_MARTIAL_ARTS,ExerciseSessionType.EXERCISE_SESSION_TYPE_PADDLING,ExerciseSessionType.EXERCISE_SESSION_TYPE_PARAGLIDING,ExerciseSessionType.EXERCISE_SESSION_TYPE_PILATES,ExerciseSessionType.EXERCISE_SESSION_TYPE_RACQUETBALL,ExerciseSessionType.EXERCISE_SESSION_TYPE_ROCK_CLIMBING,ExerciseSessionType.EXERCISE_SESSION_TYPE_ROLLER_HOCKEY,ExerciseSessionType.EXERCISE_SESSION_TYPE_ROWING,ExerciseSessionType.EXERCISE_SESSION_TYPE_ROWING_MACHINE,ExerciseSessionType.EXERCISE_SESSION_TYPE_RUGBY,ExerciseSessionType.EXERCISE_SESSION_TYPE_RUNNING,ExerciseSessionType.EXERCISE_SESSION_TYPE_RUNNING_TREADMILL,ExerciseSessionType.EXERCISE_SESSION_TYPE_SAILING,ExerciseSessionType.EXERCISE_SESSION_TYPE_SCUBA_DIVING,ExerciseSessionType.EXERCISE_SESSION_TYPE_SKATING,ExerciseSessionType.EXERCISE_SESSION_TYPE_SKIING,ExerciseSessionType.EXERCISE_SESSION_TYPE_SNOWBOARDING,ExerciseSessionType.EXERCISE_SESSION_TYPE_SNOWSHOEING,ExerciseSessionType.EXERCISE_SESSION_TYPE_SOCCER,ExerciseSessionType.EXERCISE_SESSION_TYPE_SOFTBALL,ExerciseSessionType.EXERCISE_SESSION_TYPE_SQUASH,ExerciseSessionType.EXERCISE_SESSION_TYPE_STAIR_CLIMBING,ExerciseSessionType.EXERCISE_SESSION_TYPE_STAIR_CLIMBING_MACHINE,ExerciseSessionType.EXERCISE_SESSION_TYPE_STRENGTH_TRAINING,ExerciseSessionType.EXERCISE_SESSION_TYPE_STRETCHING,ExerciseSessionType.EXERCISE_SESSION_TYPE_SURFING,ExerciseSessionType.EXERCISE_SESSION_TYPE_SWIMMING_OPEN_WATER,ExerciseSessionType.EXERCISE_SESSION_TYPE_SWIMMING_POOL,ExerciseSessionType.EXERCISE_SESSION_TYPE_TABLE_TENNIS,ExerciseSessionType.EXERCISE_SESSION_TYPE_TENNIS,ExerciseSessionType.EXERCISE_SESSION_TYPE_VOLLEYBALL,ExerciseSessionType.EXERCISE_SESSION_TYPE_WALKING,ExerciseSessionType.EXERCISE_SESSION_TYPE_WATER_POLO,ExerciseSessionType.EXERCISE_SESSION_TYPE_WEIGHTLIFTING,ExerciseSessionType.EXERCISE_SESSION_TYPE_WHEELCHAIR,ExerciseSessionType.EXERCISE_SESSION_TYPE_OTHER_WORKOUT, orExerciseSessionType.EXERCISE_SESSION_TYPE_YOGA | 
    
 
    getNotes
    
public CharSequence getNotes ()
    
    
    
  Returns notes for this planned session. Returns null if it doesn't have notes.
    
 
    getStartDate
    
public LocalDate getStartDate ()
    
    
    
  Returns the start date of the planned session.
    
 
    getTitle
    
public CharSequence getTitle ()
    
    
    
  Returns title of this planned session. Returns null if it doesn't have a title.
    
 
    hasExplicitTime
    
public boolean hasExplicitTime ()
    
    
    
  Returns whether this planned session has an explicit time. If only a date was provided this
 will be false.
    
 
    hashCode
    
public int hashCode ()
    
    
    
  Returns a hash code value for the object.
    
      | Returns | 
|---|
      
        | int | a hash code value for this object. | 
    
 
  
  
    
  
  
    
      
      
    
    
      
    
    
  
       
    
    
      
    
  
  
  Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
  Last updated 2025-02-10 UTC.
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[]]