A B C D E G H I M O P S T U V

A

acknowledge(String, String) - Method in interface org.sakaiproject.pasystem.api.Acknowledger

Mark an item as acknowledged with a type-appropriate acknowledgement type.

acknowledge(String, String, AcknowledgementType) - Method in interface org.sakaiproject.pasystem.api.Acknowledger

Mark an item as acknowledged with a specific acknowledgement type.

AcknowledgementType - Enum in org.sakaiproject.pasystem.api

Acknowledger - Interface in org.sakaiproject.pasystem.api

Methods implemented by things that can be marked as acknowledged (popups and banners).

addError(String, String) - Method in class org.sakaiproject.pasystem.api.Errors

B

Banner - Class in org.sakaiproject.pasystem.api

A data object representing a banner.

Banner(String, String, boolean, long, long, String) - Constructor for class org.sakaiproject.pasystem.api.Banner

Banner(String, String, String, boolean, long, long, String) - Constructor for class org.sakaiproject.pasystem.api.Banner

Banner(String, String, String, boolean, long, long, String, boolean) - Constructor for class org.sakaiproject.pasystem.api.Banner

Banners - Interface in org.sakaiproject.pasystem.api

The interface for the banners sub-service.

C

calculateAcknowledgementType() - Method in class org.sakaiproject.pasystem.api.Banner

Determine the default acknowledgement type for this banner.

clearTemporaryDismissedForUser(String) - Method in interface org.sakaiproject.pasystem.api.Banners

Forget all acknowledgements for the current user.

compareTo(Banner) - Method in class org.sakaiproject.pasystem.api.Banner

create(String, long, long, boolean) - Static method in class org.sakaiproject.pasystem.api.Popup

Return a new popup with some pre-populated values.

create(String, String, long, long, boolean) - Static method in class org.sakaiproject.pasystem.api.Popup

Return a popup with an existing UUID.

create(String, String, long, long, boolean, String) - Static method in class org.sakaiproject.pasystem.api.Popup

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

createBanner(Banner) - Method in interface org.sakaiproject.pasystem.api.Banners

createCampaign(Popup, TemplateStream, Optional<List<String>>) - Method in interface org.sakaiproject.pasystem.api.Popups

createNullPopup() - Static method in class org.sakaiproject.pasystem.api.Popup

Return a new popup that won't display anything.

D

dbValue() - Method in enum org.sakaiproject.pasystem.api.AcknowledgementType

deleteBanner(String) - Method in interface org.sakaiproject.pasystem.api.Banners

deleteCampaign(String) - Method in interface org.sakaiproject.pasystem.api.Popups

destroy() - Method in interface org.sakaiproject.pasystem.api.PASystem

E

equals(Object) - Method in class org.sakaiproject.pasystem.api.Banner

Errors - Class in org.sakaiproject.pasystem.api

A collection of validation errors.

Errors() - Constructor for class org.sakaiproject.pasystem.api.Errors

G

getAll() - Method in interface org.sakaiproject.pasystem.api.Banners

getAll() - Method in interface org.sakaiproject.pasystem.api.Popups

getAssigneeEids(String) - Method in interface org.sakaiproject.pasystem.api.Popups

getBanners() - Method in interface org.sakaiproject.pasystem.api.PASystem

Return the banners sub-service

getFooter() - Method in interface org.sakaiproject.pasystem.api.PASystem

Return the HTML to be appended to the bottom of each portal page.

getForId(String) - Method in interface org.sakaiproject.pasystem.api.Banners

getForId(String) - Method in interface org.sakaiproject.pasystem.api.Popups

getI18n(ClassLoader, String) - Method in interface org.sakaiproject.pasystem.api.PASystem

Return an I18N translator for a given file and locale.

getPopupContent(String) - Method in interface org.sakaiproject.pasystem.api.Popups

getPopups() - Method in interface org.sakaiproject.pasystem.api.PASystem

Return the popups sub-service.

getRelevantBanners(String, String) - Method in interface org.sakaiproject.pasystem.api.Banners

A list of banners that should be shown for a given server and user.

getSeverityScore() - Method in class org.sakaiproject.pasystem.api.Banner

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

getTemplate() - Method in class org.sakaiproject.pasystem.api.Popup

The HTML to be shown for this popup.

getType() - Method in class org.sakaiproject.pasystem.api.Banner

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

getUuid() - Method in class org.sakaiproject.pasystem.api.Banner

getUuid() - Method in class org.sakaiproject.pasystem.api.Popup

H

hasErrors() - Method in class org.sakaiproject.pasystem.api.Errors

hashCode() - Method in class org.sakaiproject.pasystem.api.Banner

I

I18n - Interface in org.sakaiproject.pasystem.api

An I18N interface.

init() - Method in interface org.sakaiproject.pasystem.api.PASystem

isActiveForHost(String) - Method in class org.sakaiproject.pasystem.api.Banner

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

isActiveNow() - Method in class org.sakaiproject.pasystem.api.Banner

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

isActiveNow() - Method in class org.sakaiproject.pasystem.api.Popup

Whether a given popup could be displayed right now.

isDismissible() - Method in class org.sakaiproject.pasystem.api.Banner

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

M

merge(Errors) - Method in class org.sakaiproject.pasystem.api.Errors

Combine the errors in this object with the errors in another.

MissingUuidException - Exception in org.sakaiproject.pasystem.api

MissingUuidException(String) - Constructor for exception org.sakaiproject.pasystem.api.MissingUuidException

O

of(String) - Static method in enum org.sakaiproject.pasystem.api.AcknowledgementType

org.sakaiproject.pasystem.api - package org.sakaiproject.pasystem.api

P

PASystem - Interface in org.sakaiproject.pasystem.api

The interface for the PA System service.

PASystemException - Exception in org.sakaiproject.pasystem.api

A generic PASystem exception.

PASystemException(String) - Constructor for exception org.sakaiproject.pasystem.api.PASystemException

PASystemException(String, Throwable) - Constructor for exception org.sakaiproject.pasystem.api.PASystemException

Popup - Class in org.sakaiproject.pasystem.api

A data object representing a popup.

Popups - Interface in org.sakaiproject.pasystem.api

The interface for the popups sub-service.

S

startTimeBeforeEndTime(long, long) - Static method in class org.sakaiproject.pasystem.api.ValidationHelper

T

t(String) - Method in interface org.sakaiproject.pasystem.api.I18n

Find the translation string for a given key.

TemplateStream - Class in org.sakaiproject.pasystem.api

A source of template character data.

TemplateStream() - Constructor for class org.sakaiproject.pasystem.api.TemplateStream

toList() - Method in class org.sakaiproject.pasystem.api.Errors

toMap() - Method in class org.sakaiproject.pasystem.api.Errors

U

updateBanner(Banner) - Method in interface org.sakaiproject.pasystem.api.Banners

updateCampaign(Popup, Optional<TemplateStream>, Optional<List<String>>) - Method in interface org.sakaiproject.pasystem.api.Popups

V

validate() - Method in class org.sakaiproject.pasystem.api.Banner

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

validate() - Method in class org.sakaiproject.pasystem.api.Popup

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

ValidationHelper - Class in org.sakaiproject.pasystem.api

Miscellaneous input validation helpers.

ValidationHelper() - Constructor for class org.sakaiproject.pasystem.api.ValidationHelper

valueOf(String) - Static method in enum org.sakaiproject.pasystem.api.AcknowledgementType

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.sakaiproject.pasystem.api.AcknowledgementType

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G H I M O P S T U V