me.vertretungsplan.objects

Class SubstitutionScheduleData

java.lang.Object

me.vertretungsplan.objects.SubstitutionScheduleData

public class SubstitutionScheduleData
extends java.lang.Object

Contains data about a school's substitution schedule. This has to be provided to a SubstitutionScheduleParser instance so that it can parse the schedule.

Constructor Summary

Constructors

Constructor and Description
SubstitutionScheduleData()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAdditionalInfos() Get the types of AdditionalInfo this schedule should contain.
java.lang.String	getApi() Get the type of parser to use for this schedule, as a string representation.
AuthenticationData	getAuthenticationData() Get information about what kind of Credential is needed to parse this schedule and if there are additional parameters for authentication (such as a pre-set school number with only the password needing to be filled in).
org.json.JSONObject	getData() Get additional data about this substitution schedule in form of a JSON object.
SubstitutionSchedule.Type	getType() Get the SubstitutionSchedule.Type of the substitution schedule this data represents
void	setAdditionalInfos(java.util.List<java.lang.String> additionalInfos) Set the types of AdditionalInfo this schedule should contain.
void	setApi(java.lang.String api) Set the type of parser to use for this schedule, as a string representation.
void	setAuthenticationData(AuthenticationData authenticationData) Set information about what kind of Credential is needed to parse this schedule and if there are additional parameters for authentication (such as a pre-set school number with only the password needing to be filled in).
void	setData(org.json.JSONObject data) Set additional data about this substitution schedule in form of a JSON object.
void	setType(SubstitutionSchedule.Type type) Set the SubstitutionSchedule.Type of the substitution schedule this data represents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubstitutionScheduleData

public SubstitutionScheduleData()

Method Detail

getType

public SubstitutionSchedule.Type getType()

Get the SubstitutionSchedule.Type of the substitution schedule this data represents

Returns:

the type of this schedule

setType

public void setType(SubstitutionSchedule.Type type)

Set the SubstitutionSchedule.Type of the substitution schedule this data represents

Parameters:

type - the type of this schedule

getApi

public java.lang.String getApi()

Get the type of parser to use for this schedule, as a string representation. This is used by BaseParser.getInstance(SubstitutionScheduleData, CookieProvider) to create a suitable parser instance.

Returns:

the type of parser to use

setApi

public void setApi(java.lang.String api)

Set the type of parser to use for this schedule, as a string representation. This information is used by BaseParser.getInstance(SubstitutionScheduleData, CookieProvider) to create a suitable parser instance. Currently supported values are:

• "untis-monitor"
• "untis-info"
• "untis-info-headless"
• "untis-subst"
• "dsbmobile"
• "svplan"
• "davinci"
• "turbovertretung"
• "csv"
• "legionboard"

Parameters:

api - the type of parser to use

getAdditionalInfos

public java.util.List<java.lang.String> getAdditionalInfos()

Get the types of AdditionalInfo this schedule should contain. Used by BaseAdditionalInfoParser.getInstance(String) to create a suitable parser instance.

Returns:

the set of additional info types

setAdditionalInfos

public void setAdditionalInfos(java.util.List<java.lang.String> additionalInfos)

Set the types of AdditionalInfo this schedule should contain. Used by BaseAdditionalInfoParser.getInstance(String) to create a suitable parser instance. Currently supported values are:

• "winter-sh"

Parameters:

additionalInfos - the additional info types to set

getData

public org.json.JSONObject getData()

Get additional data about this substitution schedule in form of a JSON object. What data is needed here depends on the parser type, see their own documentation in the me.vertretungsplan.parser package.

Returns:

additional data about this substitution schedule

setData

public void setData(org.json.JSONObject data)

Set additional data about this substitution schedule in form of a JSON object. What data is needed here depends on the parser type, see their own documentation in the me.vertretungsplan.parser package.

Parameters:

data - additional data about this substitution schedule

getAuthenticationData

public AuthenticationData getAuthenticationData()

Get information about what kind of Credential is needed to parse this schedule and if there are additional parameters for authentication (such as a pre-set school number with only the password needing to be filled in). If no credential is needed, this should return a NoAuthenticationData instance.

Returns:

the authentication data

setAuthenticationData

public void setAuthenticationData(AuthenticationData authenticationData)

Set information about what kind of Credential is needed to parse this schedule and if there are additional parameters for authentication (such as a pre-set school number with only the password needing to be filled in). If no credential is needed, set this to a NoAuthenticationData instance.

Parameters:

authenticationData - the authentication data to set