org.sagebionetworks.bridge.rest.model

Class Schedule2

java.lang.Object

org.sagebionetworks.bridge.rest.model.Schedule2

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

A design-time representation of a schedule for participants to perform (for the v2 of our scheduling API).

Constructor Summary

Constructors

Constructor and Description
Schedule2()

Method Summary

Modifier and Type	Method and Description
Schedule2	addSessionsItem(Session sessionsItem)
Schedule2	addStudyBurstsItem(StudyBurst studyBurstsItem)
Schedule2	clientData(Object clientData)
Schedule2	deleted(Boolean deleted)
Schedule2	duration(String duration)
boolean	equals(Object o)
Object	getClientData() Client data for a schedule should be in a syntactically valid JSON format.
DateTime	getCreatedOn() The date and time the schedule was created.
String	getDuration() The length of time this schedule will run for.
String	getGuid() The unique identifier for this model.
DateTime	getModifiedOn() The date and time the schedule was last modified.
String	getName() The name of the schedule as shown to a study designer.
String	getOwnerId() The identifier of the organization that owns this schedule.
List<Session>	getSessions() An ordered collection of sessions.
List<StudyBurst>	getStudyBursts() Get studyBursts
String	getType() Schedule
Long	getVersion() The optimistic locking version of the schedule.
Schedule2	guid(String guid)
int	hashCode()
Boolean	isDeleted() Has this schedule been logically deleted? An admin can restore it.
Boolean	isPublished() Has this schedule been published? Mo further changes can be made to the schedule after publication.
Schedule2	name(String name)
Schedule2	ownerId(String ownerId)
Schedule2	published(Boolean published)
Schedule2	sessions(List<Session> sessions)
void	setClientData(Object clientData)
void	setDeleted(Boolean deleted)
void	setDuration(String duration)
void	setGuid(String guid)
void	setName(String name)
void	setOwnerId(String ownerId)
void	setPublished(Boolean published)
void	setSessions(List<Session> sessions)
void	setStudyBursts(List<StudyBurst> studyBursts)
void	setVersion(Long version)
Schedule2	studyBursts(List<StudyBurst> studyBursts)
String	toString()
Schedule2	version(Long version)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Schedule2

public Schedule2()

Method Detail

ownerId

public Schedule2 ownerId(String ownerId)

getOwnerId

public String getOwnerId()

The identifier of the organization that owns this schedule.

Returns:

ownerId

setOwnerId

public void setOwnerId(String ownerId)

name

public Schedule2 name(String name)

getName

public String getName()

The name of the schedule as shown to a study designer.

Returns:

name

setName

public void setName(String name)

guid

public Schedule2 guid(String guid)

getGuid

public String getGuid()

The unique identifier for this model.

Returns:

guid

setGuid

public void setGuid(String guid)

duration

public Schedule2 duration(String duration)

getDuration

public String getDuration()

The length of time this schedule will run for. Only day and week values are allowed (although these can be mixed).

Returns:

duration

setDuration

public void setDuration(String duration)

published

public Schedule2 published(Boolean published)

isPublished

public Boolean isPublished()

Has this schedule been published? Mo further changes can be made to the schedule after publication.

Returns:

published

setPublished

public void setPublished(Boolean published)

deleted

public Schedule2 deleted(Boolean deleted)

isDeleted

public Boolean isDeleted()

Has this schedule been logically deleted? An admin can restore it.

Returns:

deleted

setDeleted

public void setDeleted(Boolean deleted)

clientData

public Schedule2 clientData(Object clientData)

getClientData

public Object getClientData()

Client data for a schedule should be in a syntactically valid JSON format. It will be returned as is to the client (as JSON). It can contain any information that is useful to authoring tools or administration tools that is not part of the Bridge data model.

Returns:

clientData

setClientData

public void setClientData(Object clientData)

studyBursts

public Schedule2 studyBursts(List<StudyBurst> studyBursts)

addStudyBurstsItem

public Schedule2 addStudyBurstsItem(StudyBurst studyBurstsItem)

getStudyBursts

public List<StudyBurst> getStudyBursts()

Get studyBursts

Returns:

studyBursts

setStudyBursts

public void setStudyBursts(List<StudyBurst> studyBursts)

sessions

public Schedule2 sessions(List<Session> sessions)

addSessionsItem

public Schedule2 addSessionsItem(Session sessionsItem)

getSessions

public List<Session> getSessions()

An ordered collection of sessions.

Returns:

sessions

setSessions

public void setSessions(List<Session> sessions)

getCreatedOn

public DateTime getCreatedOn()

The date and time the schedule was created.

Returns:

createdOn

getModifiedOn

public DateTime getModifiedOn()

The date and time the schedule was last modified.

Returns:

modifiedOn

version

public Schedule2 version(Long version)

getVersion

public Long getVersion()

The optimistic locking version of the schedule. This value must be submitted as part of the next update of the model. If it does not match the value on the server, a 409 error (Conflict) will prevent the update from occurring.

Returns:

version

setVersion

public void setVersion(Long version)

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