me.vertretungsplan.parser

Interface SubstitutionScheduleParser

All Known Implementing Classes:

BaseParser, CSVParser, DaVinciParser, ESchoolParser, IndiwareMobileParser, IndiwareParser, IndiwareStundenplan24Parser, IphisParser, LegionBoardParser, NotCompatibleParser, SchoolJoomlaParser, SVPlanParser, TurboVertretungParser, UntisCommonParser, UntisInfoHeadlessParser, UntisInfoParser, UntisMonitorParser, UntisSubstitutionParser, WebUntisParser

public interface SubstitutionScheduleParser

Parser for a substitution schedule. Uses information from a SubstitutionScheduleData object to load and parse the current substitution schedule and return the result as a SubstitutionSchedule object.

Method Summary

Modifier and Type	Method and Description
Credential	getCredential()
org.joda.time.LocalDateTime	getLastChange() Returns the time when the substitution schedule was last changed.
SubstitutionSchedule	getSubstitutionSchedule() Downloads and parses the substitution schedule
boolean	isPersonal() Some substitution schedule systems allow the user to only see his "own" substitution schedule depending on the credentials he enters.
void	setCredential(Credential credential)

Method Detail

getSubstitutionSchedule

SubstitutionSchedule getSubstitutionSchedule()
                                      throws java.io.IOException,
                                             org.json.JSONException,
                                             CredentialInvalidException

Downloads and parses the substitution schedule

Returns:

the parsed SubstitutionSchedule

Throws:

java.io.IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException - the supplied credential (BaseParser.setCredential(Credential) is not correct

getLastChange

org.joda.time.LocalDateTime getLastChange()
                                   throws java.io.IOException,
                                          org.json.JSONException,
                                          CredentialInvalidException

Returns the time when the substitution schedule was last changed. This can be used to use a previously cached schedule if nothing was changed. Should return null if this information is not available or should not be relied upon. The default implementation in BaseParser returns null.

Returns:

the time when the substitution schedule was last changed

Throws:

java.io.IOException - Connection or parsing error

org.json.JSONException - Error with the JSON configuration

CredentialInvalidException - the supplied credential (BaseParser.setCredential(Credential) is not correct

setCredential

void setCredential(Credential credential)

getCredential

Credential getCredential()

isPersonal

boolean isPersonal()

Some substitution schedule systems allow the user to only see his "own" substitution schedule depending on the credentials he enters. If this is the case - i.e. the parser can return different schedules depending on the credentials - this function should be overridden to return true.

Returns:

whether this parser returns personal schedules