Package com.appiancorp.suiteapi.portal
Class Notification
java.lang.Object
com.appiancorp.suiteapi.portal.Notification
- All Implemented Interfaces:
Serializable
Deprecated.
The Notification functionality will be removed in a future release. Use the Tempo Interface for similar functionality.
Holds information about a notification received by the Portal from the notification framework.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Integer
Deprecated.A constant sort property for notification - sort by applicationstatic final Integer
Deprecated.A constant sort property for notification - sort by application iconstatic final Integer
Deprecated.A constant sort property for notification - sort by attributesstatic final Integer
Deprecated.A constant sort property for notification - sort by idstatic final Integer
Deprecated.A constant sort property for notification - sort by notifcation typestatic final Integer
Deprecated.A constant sort property for notification - sort by page rendererstatic final Integer
Deprecated.A constant sort property for notification - sort by read statusstatic final Integer
Deprecated.A constant sort property for notification - sort by string rendererstatic final Integer
Deprecated.A constant sort property for notification - sort by timestampstatic final Integer
Deprecated.A constant sort property for notification - sort by type icon -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.the name of the application that generated this notificationDeprecated.the uri of an icon representing the application that generated this notificationDeprecated.a map of name-value attributes that are specific for each notification typegetId()
Deprecated.the unique identifier of this notificationstatic Long[]
getIds
(Notification[] notifs) Deprecated.Get the ids (as a Long array) from an array of Notification objects.Deprecated.the type of notificationDeprecated.the uri to call to render this notification as an html pageboolean
getRead()
Deprecated.Has the notification been read?static int
getSortProperty
(String attribute_) Deprecated.Gets the (zero-based) index of the sort property referred to by the given attribute.Deprecated.the uri to call to render this notification as a single line of textDeprecated.the time at which this notification was generatedDeprecated.the uri of an icon representing the type of this notificationvoid
Deprecated.seegetApplication()
void
Deprecated.void
setAttributes
(Map p) Deprecated.seegetAttributes()
void
Deprecated.seegetId()
void
Deprecated.void
Deprecated.void
setRead
(boolean r) Deprecated.seegetRead()
void
Deprecated.void
Deprecated.seegetTimestamp()
void
Deprecated.seegetTypeIcon()
-
Field Details
-
SORT_BY_READ
Deprecated.A constant sort property for notification - sort by read status -
SORT_BY_ID
Deprecated.A constant sort property for notification - sort by id -
SORT_BY_TIMESTAMP
Deprecated.A constant sort property for notification - sort by timestamp -
SORT_BY_ATTRIBUTES
Deprecated.A constant sort property for notification - sort by attributes -
SORT_BY_APPLICATION
Deprecated.A constant sort property for notification - sort by application -
SORT_BY_NOTIFICATION_TYPE
Deprecated.A constant sort property for notification - sort by notifcation type -
SORT_BY_STRING_RENDERER
Deprecated.A constant sort property for notification - sort by string renderer -
SORT_BY_PAGE_RENDERER
Deprecated.A constant sort property for notification - sort by page renderer -
SORT_BY_APPLICATION_ICON
Deprecated.A constant sort property for notification - sort by application icon -
SORT_BY_TYPE_ICON
Deprecated.A constant sort property for notification - sort by type icon
-
-
Constructor Details
-
Notification
public Notification()Deprecated.
-
-
Method Details
-
setId
Deprecated.seegetId()
-
getId
Deprecated.the unique identifier of this notification -
setApplication
Deprecated.seegetApplication()
-
getApplication
Deprecated.the name of the application that generated this notification -
setNotificationType
Deprecated. -
getNotificationType
Deprecated.the type of notification -
setTimestamp
Deprecated.seegetTimestamp()
-
getTimestamp
Deprecated.the time at which this notification was generated -
setStringRenderer
Deprecated. -
getStringRenderer
Deprecated.the uri to call to render this notification as a single line of text -
setPageRenderer
Deprecated. -
getPageRenderer
Deprecated.the uri to call to render this notification as an html page -
setApplicationIcon
Deprecated. -
getApplicationIcon
Deprecated.the uri of an icon representing the application that generated this notification -
setTypeIcon
Deprecated.seegetTypeIcon()
-
getTypeIcon
Deprecated.the uri of an icon representing the type of this notification -
setAttributes
Deprecated.seegetAttributes()
-
getAttributes
Deprecated.a map of name-value attributes that are specific for each notification type -
setRead
public void setRead(boolean r) Deprecated.seegetRead()
-
getRead
public boolean getRead()Deprecated.Has the notification been read? -
getSortProperty
Deprecated.Gets the (zero-based) index of the sort property referred to by the given attribute.- Parameters:
attribute_
- the name of a property of this bean- Returns:
- the index on which to sort, or SORT_BY_TIMESTAMP if the attribute is not recognized.
-
getIds
Deprecated.Get the ids (as a Long array) from an array of Notification objects.- Parameters:
notifs
- an array of notifications- Returns:
- an array of the same size as the given array, containing the ids of the given notifications
-