me.vertretungsplan.objects

Class AdditionalInfo

java.lang.Object

me.vertretungsplan.objects.AdditionalInfo

public class AdditionalInfo
extends java.lang.Object

Represents an additional information on the substitution schedule. AdditionalInfos are not related to a specific day on the schedule (such as miscellaneous news the school might provide in DSBmobile and similar systems) and/or come from an independent source (such as information about cancellation of classes caused by snow or other extreme weather conditions provided by the Ministry of Education). For messages that don't satisfy one of these conditions, using SubstitutionScheduleDay.addMessage(String) might be more appropriate.

Constructor Summary

Constructors

Constructor and Description
AdditionalInfo()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getText() Get the content text of this additional info.
java.lang.String	getTitle() Get the title of this additional info
int	hashCode()
boolean	hasInformation() Find out if this AdditionalInfo contains urgent information the user of an app should be notified about.
boolean	isFromSchedule()
void	setFromSchedule(boolean fromSchedule) Set whether this AdditionalInfo was parsed from the school's own schedule (true) or from a separate AdditionalInfoParser (false).
void	setHasInformation(boolean hasInformation) Set if this AdditionalInfo contains urgent information the user of an app should be notified about.
void	setText(java.lang.String text) Set the content text of this additional info.
void	setTitle(java.lang.String title) Set the title of this additional info.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdditionalInfo

public AdditionalInfo()

Method Detail

getTitle

@NotNull
public java.lang.String getTitle()

Get the title of this additional info

Returns:

the title

setTitle

public void setTitle(@NotNull
                     java.lang.String title)

Set the title of this additional info. Required.

Parameters:

title - the title to set

getText

@NotNull
public java.lang.String getText()

Get the content text of this additional info. May include simple HTML markup (only a subset of the tags is supported, such as <b>bold</b> and <i>italic</i>.

Returns:

the text

setText

public void setText(@NotNull
                    java.lang.String text)

Set the content text of this additional info. May include simple HTML markup (only a subset of the tags is supported, such as <b>bold</b> and <i>italic</i>. Required.

Parameters:

text - the text to set

hasInformation

public boolean hasInformation()

Find out if this AdditionalInfo contains urgent information the user of an app should be notified about.

Returns:

boolean indicating if this AdditionalInfo contains urgent information

setHasInformation

public void setHasInformation(boolean hasInformation)

Set if this AdditionalInfo contains urgent information the user of an app should be notified about.

Parameters:

hasInformation - boolean indicating if this AdditionalInfo contains urgent information

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isFromSchedule

public boolean isFromSchedule()

Returns:

Whether this AdditionalInfo was parsed from the school's own schedule (true) or from a separate AdditionalInfoParser (false).

setFromSchedule

public void setFromSchedule(boolean fromSchedule)

Set whether this AdditionalInfo was parsed from the school's own schedule (true) or from a separate AdditionalInfoParser (false).

Parameters:

fromSchedule - whether this AdditionalInfo was parsed from the school's own schedule