com.appiancorp.suiteapi.portal

Class Notification

java.lang.Object

com.appiancorp.suiteapi.portal.Notification

All Implemented Interfaces:

java.io.Serializable

Deprecated.

The Notification functionality will be removed in a future release. Use the Tempo Interface for similar functionality.

@Deprecated
public class Notification
extends java.lang.Object
implements java.io.Serializable

Holds information about a notification received by the Portal from the notification framework.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	SORT_BY_APPLICATION Deprecated. A constant sort property for notification - sort by application
static java.lang.Integer	SORT_BY_APPLICATION_ICON Deprecated. A constant sort property for notification - sort by application icon
static java.lang.Integer	SORT_BY_ATTRIBUTES Deprecated. A constant sort property for notification - sort by attributes
static java.lang.Integer	SORT_BY_ID Deprecated. A constant sort property for notification - sort by id
static java.lang.Integer	SORT_BY_NOTIFICATION_TYPE Deprecated. A constant sort property for notification - sort by notifcation type
static java.lang.Integer	SORT_BY_PAGE_RENDERER Deprecated. A constant sort property for notification - sort by page renderer
static java.lang.Integer	SORT_BY_READ Deprecated. A constant sort property for notification - sort by read status
static java.lang.Integer	SORT_BY_STRING_RENDERER Deprecated. A constant sort property for notification - sort by string renderer
static java.lang.Integer	SORT_BY_TIMESTAMP Deprecated. A constant sort property for notification - sort by timestamp
static java.lang.Integer	SORT_BY_TYPE_ICON Deprecated. A constant sort property for notification - sort by type icon

Constructor Summary

Constructors

Constructor and Description
Notification() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplication() Deprecated. the name of the application that generated this notification
java.lang.String	getApplicationIcon() Deprecated. the uri of an icon representing the application that generated this notification
java.util.Map	getAttributes() Deprecated. a map of name-value attributes that are specific for each notification type
java.lang.Long	getId() Deprecated. the unique identifier of this notification
static java.lang.Long[]	getIds(Notification[] notifs) Deprecated. Get the ids (as a Long array) from an array of Notification objects.
java.lang.String	getNotificationType() Deprecated. the type of notification
java.lang.String	getPageRenderer() Deprecated. the uri to call to render this notification as an html page
boolean	getRead() Deprecated. Has the notification been read?
static int	getSortProperty(java.lang.String attribute_) Deprecated. Gets the (zero-based) index of the sort property referred to by the given attribute.
java.lang.String	getStringRenderer() Deprecated. the uri to call to render this notification as a single line of text
java.sql.Timestamp	getTimestamp() Deprecated. the time at which this notification was generated
java.lang.String	getTypeIcon() Deprecated. the uri of an icon representing the type of this notification
void	setApplication(java.lang.String p) Deprecated. see getApplication()
void	setApplicationIcon(java.lang.String p) Deprecated. see getApplicationIcon()
void	setAttributes(java.util.Map p) Deprecated. see getAttributes()
void	setId(java.lang.Long p) Deprecated. see getId()
void	setNotificationType(java.lang.String p) Deprecated. see getNotificationType()
void	setPageRenderer(java.lang.String p) Deprecated. see getPageRenderer()
void	setRead(boolean r) Deprecated. see getRead()
void	setStringRenderer(java.lang.String p) Deprecated. see getStringRenderer()
void	setTimestamp(java.sql.Timestamp p) Deprecated. see getTimestamp()
void	setTypeIcon(java.lang.String p) Deprecated. see getTypeIcon()

Methods inherited from class java.lang.Object

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

Field Detail

SORT_BY_READ

public static final java.lang.Integer SORT_BY_READ

Deprecated.

A constant sort property for notification - sort by read status

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

Deprecated.

A constant sort property for notification - sort by id

SORT_BY_TIMESTAMP

public static final java.lang.Integer SORT_BY_TIMESTAMP

Deprecated.

A constant sort property for notification - sort by timestamp

SORT_BY_ATTRIBUTES

public static final java.lang.Integer SORT_BY_ATTRIBUTES

Deprecated.

A constant sort property for notification - sort by attributes

SORT_BY_APPLICATION

public static final java.lang.Integer SORT_BY_APPLICATION

Deprecated.

A constant sort property for notification - sort by application

SORT_BY_NOTIFICATION_TYPE

public static final java.lang.Integer SORT_BY_NOTIFICATION_TYPE

Deprecated.

A constant sort property for notification - sort by notifcation type

SORT_BY_STRING_RENDERER

public static final java.lang.Integer SORT_BY_STRING_RENDERER

Deprecated.

A constant sort property for notification - sort by string renderer

SORT_BY_PAGE_RENDERER

public static final java.lang.Integer SORT_BY_PAGE_RENDERER

Deprecated.

A constant sort property for notification - sort by page renderer

SORT_BY_APPLICATION_ICON

public static final java.lang.Integer SORT_BY_APPLICATION_ICON

Deprecated.

A constant sort property for notification - sort by application icon

SORT_BY_TYPE_ICON

public static final java.lang.Integer SORT_BY_TYPE_ICON

Deprecated.

A constant sort property for notification - sort by type icon

Constructor Detail

Notification

public Notification()

Deprecated.

Method Detail

setId

public void setId(java.lang.Long p)

Deprecated.

see getId()

getId

public java.lang.Long getId()

Deprecated.

the unique identifier of this notification

setApplication

public void setApplication(java.lang.String p)

Deprecated.

see getApplication()

getApplication

public java.lang.String getApplication()

Deprecated.

the name of the application that generated this notification

setNotificationType

public void setNotificationType(java.lang.String p)

Deprecated.

see getNotificationType()

getNotificationType

public java.lang.String getNotificationType()

Deprecated.

the type of notification

setTimestamp

public void setTimestamp(java.sql.Timestamp p)

Deprecated.

see getTimestamp()

getTimestamp

public java.sql.Timestamp getTimestamp()

Deprecated.

the time at which this notification was generated

setStringRenderer

public void setStringRenderer(java.lang.String p)

Deprecated.

see getStringRenderer()

getStringRenderer

public java.lang.String getStringRenderer()

Deprecated.

the uri to call to render this notification as a single line of text

setPageRenderer

public void setPageRenderer(java.lang.String p)

Deprecated.

see getPageRenderer()

getPageRenderer

public java.lang.String getPageRenderer()

Deprecated.

the uri to call to render this notification as an html page

setApplicationIcon

public void setApplicationIcon(java.lang.String p)

Deprecated.

see getApplicationIcon()

getApplicationIcon

public java.lang.String getApplicationIcon()

Deprecated.

the uri of an icon representing the application that generated this notification

setTypeIcon

public void setTypeIcon(java.lang.String p)

Deprecated.

see getTypeIcon()

getTypeIcon

public java.lang.String getTypeIcon()

Deprecated.

the uri of an icon representing the type of this notification

setAttributes

public void setAttributes(java.util.Map p)

Deprecated.

see getAttributes()

getAttributes

public java.util.Map getAttributes()

Deprecated.

a map of name-value attributes that are specific for each notification type

setRead

public void setRead(boolean r)

Deprecated.

see getRead()

getRead

public boolean getRead()

Deprecated.

Has the notification been read?

getSortProperty

public static int getSortProperty(java.lang.String attribute_)

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

public static java.lang.Long[] getIds(Notification[] notifs)

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