Schedule (REST Client 0.25.15 API)

java.lang.Object
- org.sagebionetworks.bridge.rest.model.Schedule

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class Schedule
extends Object

For more information about scheduling, see [Scheduling](/articles/study_design/scheduling.html).

Constructor Summary

Constructors
Constructor and Description

Schedule()

Constructors
Constructor and Description
`Schedule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Schedule`	`activities(List<Activity> activities)`
`Schedule`	`addActivitiesItem(Activity activitiesItem)`
`Schedule`	`addTimesItem(String timesItem)`
`Schedule`	`cronTrigger(String cronTrigger)`
`Schedule`	`delay(String delay)`
`Schedule`	`endsOn(DateTime endsOn)`
`boolean`	`equals(Object o)`
`Schedule`	`eventId(String eventId)`
`Schedule`	`expires(String expires)`
`List<Activity>`	`getActivities()` One or more activities that should be done by a participant on this schedule.
`String`	`getCronTrigger()` A cron expression will schedule recurring tasks according to this standard syntax for describing event schedules from the Unix operating system.
`String`	`getDelay()` ISO 8601 duration string.
`DateTime`	`getEndsOn()` The scheduler will not create a task after this date and time.
`String`	`getEventId()` A comma-separated list of event IDs against which will be used for scheduling.
`String`	`getExpires()` ISO 8601 duration string.
`String`	`getInterval()` An ISO 8601 duration, describing the period in days between tasks (it can be days, weeks, months or even years, but should not be smaller than a day).
`String`	`getLabel()` A label to describe this schedule.
`ScheduleType`	`getScheduleType()` Get scheduleType
`String`	`getSequencePeriod()` A recurring schedule can specify a sequence in a crossover study design.
`DateTime`	`getStartsOn()` The scheduler will not create a task before this date and time.
`List<String>`	`getTimes()` Required if an interval is specified (ignored if a cron expression is specified).
`String`	`getType()` Schedule
`int`	`hashCode()`
`Schedule`	`interval(String interval)`
`Boolean`	`isPersistent()` True if schedule type is persistent.
`Schedule`	`label(String label)`
`Schedule`	`persistent(Boolean persistent)`
`Schedule`	`scheduleType(ScheduleType scheduleType)`
`Schedule`	`sequencePeriod(String sequencePeriod)`
`void`	`setActivities(List<Activity> activities)`
`void`	`setCronTrigger(String cronTrigger)`
`void`	`setDelay(String delay)`
`void`	`setEndsOn(DateTime endsOn)`
`void`	`setEventId(String eventId)`
`void`	`setExpires(String expires)`
`void`	`setInterval(String interval)`
`void`	`setLabel(String label)`
`void`	`setPersistent(Boolean persistent)`
`void`	`setScheduleType(ScheduleType scheduleType)`
`void`	`setSequencePeriod(String sequencePeriod)`
`void`	`setStartsOn(DateTime startsOn)`
`void`	`setTimes(List<String> times)`
`Schedule`	`startsOn(DateTime startsOn)`
`Schedule`	`times(List<String> times)`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Schedule
```
public Schedule()
```
- Method Detail
  - label
```
public Schedule label(String label)
```
  - getLabel
```
public String getLabel()
```
    A label to describe this schedule.
    
    Returns:
    
    label
  - setLabel
```
public void setLabel(String label)
```
  - scheduleType
```
public Schedule scheduleType(ScheduleType scheduleType)
```
  - getScheduleType
```
public ScheduleType getScheduleType()
```
    Get scheduleType
    
    Returns:
    
    scheduleType
  - setScheduleType
```
public void setScheduleType(ScheduleType scheduleType)
```
  - eventId
```
public Schedule eventId(String eventId)
```
  - getEventId
```
public String getEventId()
```
    A comma-separated list of event IDs against which will be used for scheduling. If no eventId is provided, the event `enrollment` will be used. The system will use the first event ID (working left to right) for which the user has an event with a timestamp.
    
    Returns:
    
    eventId
  - setEventId
```
public void setEventId(String eventId)
```
  - delay
```
public Schedule delay(String delay)
```
  - getDelay
```
public String getDelay()
```
    ISO 8601 duration string. An amount of time to wait before scheduling the first task.
    
    Returns:
    
    delay
  - setDelay
```
public void setDelay(String delay)
```
  - interval
```
public Schedule interval(String interval)
```
  - getInterval
```
public String getInterval()
```
    An ISO 8601 duration, describing the period in days between tasks (it can be days, weeks, months or even years, but should not be smaller than a day). If this is used, cronTrigger should not be used.
    
    Returns:
    
    interval
  - setInterval
```
public void setInterval(String interval)
```
  - sequencePeriod
```
public Schedule sequencePeriod(String sequencePeriod)
```
  - getSequencePeriod
```
public String getSequencePeriod()
```
    A recurring schedule can specify a sequence in a crossover study design. The sequence starts from the triggering event, plus any delay, and continues until the end of the period. For example, if you have a recurring schedule that repeats daily, a `sequencePeriod` of 1 day (P1D) would generate one activity. If you set `sequencePeriod` to P2D, you will get two activities. Note that this is true regardless of whether or not there is a delay. Washout periods between sequences can be specified by delaying the execution of the next sequence.
    
    Returns:
    
    sequencePeriod
  - setSequencePeriod
```
public void setSequencePeriod(String sequencePeriod)
```
  - expires
```
public Schedule expires(String expires)
```
  - getExpires
```
public String getExpires()
```
    ISO 8601 duration string. The period of time after which an unstarted, scheduled activity should be removed from the application (if it has not been started, no data will have been saved on the server). This is mandatory for recurring schedules so that unstarted activities do not stack up in the user's UI.
    
    Returns:
    
    expires
  - setExpires
```
public void setExpires(String expires)
```
  - cronTrigger
```
public Schedule cronTrigger(String cronTrigger)
```
  - getCronTrigger
```
public String getCronTrigger()
```
    A cron expression will schedule recurring tasks according to this standard syntax for describing event schedules from the Unix operating system. The format of the cron expression is the seven field format as described in the documentation for the Java Quartz Scheduler (note that there are other formats that take up to eleven fields, this online cron expression generator creates expressions in the right format). If this is used, the interval and times are ignored.
    
    Returns:
    
    cronTrigger
  - setCronTrigger
```
public void setCronTrigger(String cronTrigger)
```
  - startsOn
```
public Schedule startsOn(DateTime startsOn)
```
  - getStartsOn
```
public DateTime getStartsOn()
```
    The scheduler will not create a task before this date and time.
    
    Returns:
    
    startsOn
  - setStartsOn
```
public void setStartsOn(DateTime startsOn)
```
  - endsOn
```
public Schedule endsOn(DateTime endsOn)
```
  - getEndsOn
```
public DateTime getEndsOn()
```
    The scheduler will not create a task after this date and time. **Note that this takes precedence over the minimumPerSchedule setting that can be provided via the API. Tasks will not be \"topped up\" to this minimum if they extend outside of this time window.**
    
    Returns:
    
    endsOn
  - setEndsOn
```
public void setEndsOn(DateTime endsOn)
```
  - times
```
public Schedule times(List<String> times)
```
  - addTimesItem
```
public Schedule addTimesItem(String timesItem)
```
  - getTimes
```
public List<String> getTimes()
```
    Required if an interval is specified (ignored if a cron expression is specified). An array of one or more ISO 8601 time values (without a date or time zone, e.g. \"14:00\"). One task will be created for each time on the day determined by the rest of the scheduler. If the schedule occurs once, only the first time will be used to schedule the task (and if no time is provided, the original time of the triggering event will be used; it's clearest to set a time).
    
    Returns:
    
    times
  - setTimes
```
public void setTimes(List<String> times)
```
  - persistent
```
public Schedule persistent(Boolean persistent)
```
  - isPersistent
```
public Boolean isPersistent()
```
    True if schedule type is persistent. (This is here for legacy reasons.)
    
    Returns:
    
    persistent
  - setPersistent
```
public void setPersistent(Boolean persistent)
```
  - activities
```
public Schedule activities(List<Activity> activities)
```
  - addActivitiesItem
```
public Schedule addActivitiesItem(Activity activitiesItem)
```
  - getActivities
```
public List<Activity> getActivities()
```
    One or more activities that should be done by a participant on this schedule. Each activity will generate a separate task. See Activity.
    
    Returns:
    
    activities
  - setActivities
```
public void setActivities(List<Activity> activities)
```
  - getType
```
public String getType()
```
    Schedule
    
    Returns:
    
    type
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Schedule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Schedule

Method Detail

label

getLabel

setLabel

scheduleType

getScheduleType

setScheduleType

eventId

getEventId

setEventId

delay

getDelay

setDelay

interval

getInterval

setInterval

sequencePeriod

getSequencePeriod

setSequencePeriod

expires

getExpires

setExpires

cronTrigger

getCronTrigger

setCronTrigger

startsOn

getStartsOn

setStartsOn

endsOn

getEndsOn

setEndsOn

times

addTimesItem

getTimes

setTimes

persistent

isPersistent

setPersistent

activities

addActivitiesItem

getActivities

setActivities

getType

equals

hashCode

toString