Package org.sakaiproject.pasystem.api

Class Popup

java.lang.Object

org.sakaiproject.pasystem.api.Popup

public class Popup
extends Object

A data object representing a popup.

Method Summary

Modifier and Type	Method	Description
static Popup	create(String descriptor, long startTime, long endTime, boolean isOpenCampaign)	Return a new popup with some pre-populated values.
static Popup	create(String uuid, String descriptor, long startTime, long endTime, boolean isOpenCampaign)	Return a popup with an existing UUID.
static Popup	create(String uuid, String descriptor, long startTime, long endTime, boolean isOpenCampaign, String template)	Return a popup for an existing UUID that replaces its template.
static Popup	createNullPopup()	Return a new popup that won't display anything.
String	getTemplate()	The HTML to be shown for this popup.
String	getUuid()
boolean	isActiveNow()	Whether a given popup could be displayed right now.
Errors	validate()	Check that the values we've been given make sense.

Methods inherited from class java.lang.Object

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

Method Detail

createNullPopup

public static Popup createNullPopup()

Return a new popup that won't display anything.

create

public static Popup create(String descriptor,
                           long startTime,
                           long endTime,
                           boolean isOpenCampaign)

Return a new popup with some pre-populated values.

create

public static Popup create(String uuid,
                           String descriptor,
                           long startTime,
                           long endTime,
                           boolean isOpenCampaign)

Return a popup with an existing UUID.

create

public static Popup create(String uuid,
                           String descriptor,
                           long startTime,
                           long endTime,
                           boolean isOpenCampaign,
                           String template)

Return a popup for an existing UUID that replaces its template.

getUuid

public String getUuid()
               throws MissingUuidException

Throws:

MissingUuidException

isActiveNow

public boolean isActiveNow()

Whether a given popup could be displayed right now.

getTemplate

public String getTemplate()

The HTML to be shown for this popup.

validate

public Errors validate()

Check that the values we've been given make sense.