Package com.caplin.motif.config.definitions.common

Class GenericNotification

java.lang.Object

com.caplin.motif.config.definitions.common.GenericNotification

@Generated("org.openapitools.codegen.languages.SpringCodegen")
public class GenericNotification
extends java.lang.Object

GenericNotification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenericNotification.TypeEnum	Each of the notification types.

Constructor Summary

Constructors

Constructor	Description
GenericNotification()
GenericNotification(GenericNotification.TypeEnum type, java.lang.String dateTime, NotificationToken message)	Constructor with only required parameters

Method Summary

Modifier and Type	Method	Description
GenericNotification	category(java.lang.String category)
GenericNotification	dateTime(java.lang.String dateTime)
boolean	equals(java.lang.Object o)
java.lang.String	getCategory()	Optional token describing the notification category, it is used to display the category in the Front End notification.
@NotNull java.lang.String	getDateTime()	An ISO-8601 date-time (`YYYY-MM-DD[T]HH:mm:ss`).
@NotNull NotificationToken	getMessage()	Get message
NotificationToken	getMessageHeader()	Get messageHeader
java.lang.String	getStatus()	Optional token describing the notification status, it is used to display the status in the front end, and it will be colored according to the type property.
@NotNull GenericNotification.TypeEnum	getType()	Each of the notification types.
int	hashCode()
GenericNotification	message(NotificationToken message)
GenericNotification	messageHeader(NotificationToken messageHeader)
void	setCategory(java.lang.String category)
void	setDateTime(java.lang.String dateTime)
void	setMessage(NotificationToken message)
void	setMessageHeader(NotificationToken messageHeader)
void	setStatus(java.lang.String status)
void	setType(GenericNotification.TypeEnum type)
GenericNotification	status(java.lang.String status)
java.lang.String	toString()
GenericNotification	type(GenericNotification.TypeEnum type)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericNotification

public GenericNotification()

GenericNotification

public GenericNotification(GenericNotification.TypeEnum type,
                           java.lang.String dateTime,
                           NotificationToken message)

Constructor with only required parameters

Method Detail

type

public GenericNotification type(GenericNotification.TypeEnum type)

getType

@NotNull
public @NotNull GenericNotification.TypeEnum getType()

Each of the notification types. The Front End will represent notifications based on their types (eg. Success will show a green Status and a tick icon).

Returns:

type

setType

public void setType(GenericNotification.TypeEnum type)

status

public GenericNotification status(java.lang.String status)

getStatus

public java.lang.String getStatus()

Optional token describing the notification status, it is used to display the status in the front end, and it will be colored according to the type property. eg. notifications.status.cancelled will represent the CANCELLED status.

Returns:

status

setStatus

public void setStatus(java.lang.String status)

dateTime

public GenericNotification dateTime(java.lang.String dateTime)

getDateTime

@NotNull
public @NotNull java.lang.String getDateTime()

An ISO-8601 date-time (`YYYY-MM-DD[T]HH:mm:ss`).

Returns:

dateTime

setDateTime

public void setDateTime(java.lang.String dateTime)

category

public GenericNotification category(java.lang.String category)

getCategory

public java.lang.String getCategory()

Optional token describing the notification category, it is used to display the category in the Front End notification. eg. notifications.category.order will represent the ORDER category.

Returns:

category

setCategory

public void setCategory(java.lang.String category)

messageHeader

public GenericNotification messageHeader(NotificationToken messageHeader)

getMessageHeader

public NotificationToken getMessageHeader()

Get messageHeader

Returns:

messageHeader

setMessageHeader

public void setMessageHeader(NotificationToken messageHeader)

message

public GenericNotification message(NotificationToken message)

getMessage

@NotNull
public @NotNull NotificationToken getMessage()

Get message

Returns:

message

setMessage

public void setMessage(NotificationToken message)

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object