Class AlertLink

java.lang.Object

com.kingsrook.qqq.backend.core.alerts.AlertLink

All Implemented Interfaces:

Serializable

public class AlertLink
extends Object
implements Serializable

A link from an alert to where a person fixes it: a record, a table with a filter, an app or widget path, or an absolute URL. Exactly one target is expected, so construct these with the static factories.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AlertLink()

Method Summary

Modifier and Type	Method	Description
QQueryFilter	getFilter()	Getter for filter
String	getLabel()	Getter for label
String	getPath()	Getter for path
Serializable	getRecordId()	Getter for recordId
String	getTableName()	Getter for tableName
String	getUrl()	Getter for url
static AlertLink	toPath(String path, String label)	Link to an app or widget path within the application (e.g.
static AlertLink	toRecord(String tableName, Serializable recordId, String label)	Link to one record.
static AlertLink	toTable(String tableName, QQueryFilter filter, String label)	Link to a table, optionally filtered.
static AlertLink	toUrl(String url, String label)	Link to an absolute URL.

Methods inherited from class java.lang.Object

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

Constructor Details

AlertLink

public AlertLink()

Method Details

toRecord

public static AlertLink toRecord(String tableName,
 Serializable recordId,
 String label)

Link to one record.

toTable

public static AlertLink toTable(String tableName,
 QQueryFilter filter,
 String label)

Link to a table, optionally filtered.

toPath

public static AlertLink toPath(String path,
 String label)

Link to an app or widget path within the application (e.g. "/admin/cdn").

toUrl

public static AlertLink toUrl(String url,
 String label)

Link to an absolute URL. Implementations only follow these for types that declare them, so producer data cannot inject arbitrary links.

getLabel

public String getLabel()

Getter for label

getTableName

public String getTableName()

Getter for tableName

getRecordId

public Serializable getRecordId()

Getter for recordId

getFilter

public QQueryFilter getFilter()

Getter for filter

getPath

public String getPath()

Getter for path

getUrl

public String getUrl()

Getter for url