Package ch.examzone.sebbb.model

Class Exam

java.lang.Object

ch.examzone.sebbb.model.Exam

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2026-10-25T12:34:17.476436974Z[Etc/UTC]",
           comments="Generator version: 7.10.0")
public class Exam
extends Object

Used for create (name, starts_at, ends_at and start_url required), update (any subset) and responses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Exam.ClipboardEnum	Default block.
static class	Exam.CustomTypeAdapterFactory
static enum	Exam.StartModeEnum	Default manual: apps wait in the lobby (session state ready) until POST /v1/exams/{id}/start.
static enum	Exam.StatusEnum	running after POST /v1/exams/{id}/start, or from starts_at on with start_mode on_launch.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ALLOWED_URLS
static final String	SERIALIZED_NAME_CLIPBOARD
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_ENDED_AT
static final String	SERIALIZED_NAME_ENDS_AT
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_KIOSK
static final String	SERIALIZED_NAME_LAUNCH_URL
static final String	SERIALIZED_NAME_NAME
static final String	SERIALIZED_NAME_PRINTING
static final String	SERIALIZED_NAME_QUIT_URL
static final String	SERIALIZED_NAME_RETENTION_DAYS
static final String	SERIALIZED_NAME_SCREENSHOT
static final String	SERIALIZED_NAME_SPELLCHECK
static final String	SERIALIZED_NAME_START_MODE
static final String	SERIALIZED_NAME_START_URL
static final String	SERIALIZED_NAME_STARTED_AT
static final String	SERIALIZED_NAME_STARTS_AT
static final String	SERIALIZED_NAME_STATUS
static final String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
Exam()
Exam(OffsetDateTime createdAt, OffsetDateTime endedAt, UUID id, String launchUrl, OffsetDateTime startedAt, Exam.StatusEnum status, OffsetDateTime updatedAt)

Method Summary

Modifier and Type	Method	Description
Exam	addAllowedUrlsItem(AllowedUrl allowedUrlsItem)
Exam	allowedUrls(List<AllowedUrl> allowedUrls)
Exam	clipboard(Exam.ClipboardEnum clipboard)
Exam	endsAt(OffsetDateTime endsAt)
boolean	equals(Object o)
static Exam	fromJson(String jsonString)	Create an instance of Exam given an JSON string
List<AllowedUrl>	getAllowedUrls()	Everything else is blocked and logged.
Exam.ClipboardEnum	getClipboard()	Default block.
OffsetDateTime	getCreatedAt()	Get createdAt
OffsetDateTime	getEndedAt()	Set by POST /v1/exams/{id}/end.
OffsetDateTime	getEndsAt()	Get endsAt
UUID	getId()	Get id
KioskSettings	getKiosk()	Get kiosk
String	getLaunchUrl()	sebbb:// link that opens the app.
String	getName()	Shown in the app's title bar.
Boolean	getPrinting()	Default false.
URI	getQuitUrl()	Navigating here ends the session and releases the device.
Integer	getRetentionDays()	Events and screenshots are deleted after this many days.
ScreenshotSettings	getScreenshot()	Get screenshot
Boolean	getSpellcheck()	Default false.
OffsetDateTime	getStartedAt()	Set by POST /v1/exams/{id}/start.
Exam.StartModeEnum	getStartMode()	Default manual: apps wait in the lobby (session state ready) until POST /v1/exams/{id}/start.
OffsetDateTime	getStartsAt()	The launch link only works between starts_at and ends_at.
URI	getStartUrl()	Page the in-app browser opens on start.
Exam.StatusEnum	getStatus()	running after POST /v1/exams/{id}/start, or from starts_at on with start_mode on_launch.
OffsetDateTime	getUpdatedAt()	Get updatedAt
int	hashCode()
Exam	kiosk(KioskSettings kiosk)
Exam	name(String name)
Exam	printing(Boolean printing)
Exam	quitUrl(URI quitUrl)
Exam	retentionDays(Integer retentionDays)
Exam	screenshot(ScreenshotSettings screenshot)
void	setAllowedUrls(List<AllowedUrl> allowedUrls)
void	setClipboard(Exam.ClipboardEnum clipboard)
void	setEndsAt(OffsetDateTime endsAt)
void	setKiosk(KioskSettings kiosk)
void	setName(String name)
void	setPrinting(Boolean printing)
void	setQuitUrl(URI quitUrl)
void	setRetentionDays(Integer retentionDays)
void	setScreenshot(ScreenshotSettings screenshot)
void	setSpellcheck(Boolean spellcheck)
void	setStartMode(Exam.StartModeEnum startMode)
void	setStartsAt(OffsetDateTime startsAt)
void	setStartUrl(URI startUrl)
Exam	spellcheck(Boolean spellcheck)
Exam	startMode(Exam.StartModeEnum startMode)
Exam	startsAt(OffsetDateTime startsAt)
Exam	startUrl(URI startUrl)
String	toJson()	Convert an instance of Exam to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_ALLOWED_URLS

public static final String SERIALIZED_NAME_ALLOWED_URLS

See Also:

• Constant Field Values

SERIALIZED_NAME_CLIPBOARD

public static final String SERIALIZED_NAME_CLIPBOARD

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_ENDED_AT

public static final String SERIALIZED_NAME_ENDED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_ENDS_AT

public static final String SERIALIZED_NAME_ENDS_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_KIOSK

public static final String SERIALIZED_NAME_KIOSK

See Also:

• Constant Field Values

SERIALIZED_NAME_LAUNCH_URL

public static final String SERIALIZED_NAME_LAUNCH_URL

See Also:

• Constant Field Values

SERIALIZED_NAME_NAME

public static final String SERIALIZED_NAME_NAME

See Also:

• Constant Field Values

SERIALIZED_NAME_PRINTING

public static final String SERIALIZED_NAME_PRINTING

See Also:

• Constant Field Values

SERIALIZED_NAME_QUIT_URL

public static final String SERIALIZED_NAME_QUIT_URL

See Also:

• Constant Field Values

SERIALIZED_NAME_RETENTION_DAYS

public static final String SERIALIZED_NAME_RETENTION_DAYS

See Also:

• Constant Field Values

SERIALIZED_NAME_SCREENSHOT

public static final String SERIALIZED_NAME_SCREENSHOT

See Also:

• Constant Field Values

SERIALIZED_NAME_SPELLCHECK

public static final String SERIALIZED_NAME_SPELLCHECK

See Also:

• Constant Field Values

SERIALIZED_NAME_START_MODE

public static final String SERIALIZED_NAME_START_MODE

See Also:

• Constant Field Values

SERIALIZED_NAME_START_URL

public static final String SERIALIZED_NAME_START_URL

See Also:

• Constant Field Values

SERIALIZED_NAME_STARTED_AT

public static final String SERIALIZED_NAME_STARTED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_STARTS_AT

public static final String SERIALIZED_NAME_STARTS_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

Exam

public Exam()

Exam

public Exam(OffsetDateTime createdAt,
 OffsetDateTime endedAt,
 UUID id,
 String launchUrl,
 OffsetDateTime startedAt,
 Exam.StatusEnum status,
 OffsetDateTime updatedAt)

Method Details

allowedUrls

public Exam allowedUrls(@Nullable
 List<AllowedUrl> allowedUrls)

addAllowedUrlsItem

public Exam addAllowedUrlsItem(AllowedUrl allowedUrlsItem)

getAllowedUrls

@Nullable
public List<AllowedUrl> getAllowedUrls()

Everything else is blocked and logged.

Returns:

allowedUrls

setAllowedUrls

public void setAllowedUrls(@Nullable
 List<AllowedUrl> allowedUrls)

clipboard

public Exam clipboard(@Nullable
 Exam.ClipboardEnum clipboard)

getClipboard

@Nullable
public Exam.ClipboardEnum getClipboard()

Default block. exam_only allows copy/paste within the exam page.

Returns:

clipboard

setClipboard

public void setClipboard(@Nullable
 Exam.ClipboardEnum clipboard)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

Get createdAt

Returns:

createdAt

getEndedAt

@Nullable
public OffsetDateTime getEndedAt()

Set by POST /v1/exams/{id}/end.

Returns:

endedAt

endsAt

public Exam endsAt(@Nullable
 OffsetDateTime endsAt)

getEndsAt

@Nullable
public OffsetDateTime getEndsAt()

Get endsAt

Returns:

endsAt

setEndsAt

public void setEndsAt(@Nullable
 OffsetDateTime endsAt)

getId

@Nullable
public UUID getId()

Get id

Returns:

id

kiosk

public Exam kiosk(@Nullable
 KioskSettings kiosk)

getKiosk

@Nullable
public KioskSettings getKiosk()

Get kiosk

Returns:

kiosk

setKiosk

public void setKiosk(@Nullable
 KioskSettings kiosk)

getLaunchUrl

@Nullable
public String getLaunchUrl()

sebbb:// link that opens the app. The same for all participants.

Returns:

launchUrl

name

public Exam name(@Nullable
 String name)

getName

@Nullable
public String getName()

Shown in the app's title bar.

Returns:

name

setName

public void setName(@Nullable
 String name)

printing

public Exam printing(@Nullable
 Boolean printing)

getPrinting

@Nullable
public Boolean getPrinting()

Default false.

Returns:

printing

setPrinting

public void setPrinting(@Nullable
 Boolean printing)

quitUrl

public Exam quitUrl(@Nullable
 URI quitUrl)

getQuitUrl

@Nullable
public URI getQuitUrl()

Navigating here ends the session and releases the device.

Returns:

quitUrl

setQuitUrl

public void setQuitUrl(@Nullable
 URI quitUrl)

retentionDays

public Exam retentionDays(@Nullable
 Integer retentionDays)

getRetentionDays

@Nullable
public Integer getRetentionDays()

Events and screenshots are deleted after this many days. Default 30.

Returns:

retentionDays

setRetentionDays

public void setRetentionDays(@Nullable
 Integer retentionDays)

screenshot

public Exam screenshot(@Nullable
 ScreenshotSettings screenshot)

getScreenshot

@Nullable
public ScreenshotSettings getScreenshot()

Get screenshot

Returns:

screenshot

setScreenshot

public void setScreenshot(@Nullable
 ScreenshotSettings screenshot)

spellcheck

public Exam spellcheck(@Nullable
 Boolean spellcheck)

getSpellcheck

@Nullable
public Boolean getSpellcheck()

Default false.

Returns:

spellcheck

setSpellcheck

public void setSpellcheck(@Nullable
 Boolean spellcheck)

startMode

public Exam startMode(@Nullable
 Exam.StartModeEnum startMode)

getStartMode

@Nullable
public Exam.StartModeEnum getStartMode()

Default manual: apps wait in the lobby (session state ready) until POST /v1/exams/{id}/start. on_launch: no lobby, the app opens start_url right after the student opens the launch link, no start call needed. Switching to on_launch starts the apps waiting in the lobby.

Returns:

startMode

setStartMode

public void setStartMode(@Nullable
 Exam.StartModeEnum startMode)

startUrl

public Exam startUrl(@Nullable
 URI startUrl)

getStartUrl

@Nullable
public URI getStartUrl()

Page the in-app browser opens on start.

Returns:

startUrl

setStartUrl

public void setStartUrl(@Nullable
 URI startUrl)

getStartedAt

@Nullable
public OffsetDateTime getStartedAt()

Set by POST /v1/exams/{id}/start. Stays null with start_mode on_launch.

Returns:

startedAt

startsAt

public Exam startsAt(@Nullable
 OffsetDateTime startsAt)

getStartsAt

@Nullable
public OffsetDateTime getStartsAt()

The launch link only works between starts_at and ends_at.

Returns:

startsAt

setStartsAt

public void setStartsAt(@Nullable
 OffsetDateTime startsAt)

getStatus

@Nullable
public Exam.StatusEnum getStatus()

running after POST /v1/exams/{id}/start, or from starts_at on with start_mode on_launch.

Returns:

status

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

Get updatedAt

Returns:

updatedAt

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

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to Exam

fromJson

public static Exam fromJson(String jsonString)
                     throws IOException

Create an instance of Exam given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of Exam

Throws:

IOException - if the JSON string is invalid with respect to Exam

toJson

public String toJson()

Convert an instance of Exam to an JSON string

Returns:

JSON string