org.sakaiproject.pasystem.api

Class Banner

java.lang.Object

org.sakaiproject.pasystem.api.Banner

All Implemented Interfaces:

Comparable<Banner>

public class Banner
extends Object
implements Comparable<Banner>

A data object representing a banner.

Constructor Summary

Constructors

Constructor and Description
Banner(String message, String hosts, boolean active, long startTime, long endTime, String type)
Banner(String uuid, String message, String hosts, boolean active, long startTime, long endTime, String type)
Banner(String uuid, String message, String hosts, boolean active, long startTime, long endTime, String type, boolean isDismissed)

Method Summary

Modifier and Type	Method and Description
AcknowledgementType	calculateAcknowledgementType() Determine the default acknowledgement type for this banner.
int	compareTo(Banner other)
boolean	equals(Object obj)
int	getSeverityScore() A numeric type representing this banner's importance (higher number = more important)
String	getType() The type of this banner (high, medium, low).
String	getUuid()
int	hashCode()
boolean	isActiveForHost(String hostname) True if this banner is active now and assigned to the current server.
boolean	isActiveNow() Whether or not this banner should be displayed at this moment in time.
boolean	isDismissible() Whether or not this banner type can be dismissed by a user.
Errors	validate() Check that the values we've been given make sense.

Methods inherited from class java.lang.Object

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

Constructor Detail

Banner

public Banner(String message,
              String hosts,
              boolean active,
              long startTime,
              long endTime,
              String type)

Banner

public Banner(String uuid,
              String message,
              String hosts,
              boolean active,
              long startTime,
              long endTime,
              String type)

Banner

public Banner(String uuid,
              String message,
              String hosts,
              boolean active,
              long startTime,
              long endTime,
              String type,
              boolean isDismissed)

Method Detail

getType

public String getType()

The type of this banner (high, medium, low).

calculateAcknowledgementType

public AcknowledgementType calculateAcknowledgementType()

Determine the default acknowledgement type for this banner.

compareTo

public int compareTo(Banner other)

Specified by:

compareTo in interface Comparable<Banner>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSeverityScore

public int getSeverityScore()

A numeric type representing this banner's importance (higher number = more important)

getUuid

public String getUuid()
               throws MissingUuidException

Throws:

MissingUuidException

isActiveNow

public boolean isActiveNow()

Whether or not this banner should be displayed at this moment in time.

isDismissible

public boolean isDismissible()

Whether or not this banner type can be dismissed by a user.

isActiveForHost

public boolean isActiveForHost(String hostname)

True if this banner is active now and assigned to the current server.

validate

public Errors validate()

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