Package com.appiancorp.suiteapi.portal

Class Notification

java.lang.Object
com.appiancorp.suiteapi.portal.Notification
All Implemented Interfaces:
Serializable
@Deprecated public class Notification extends Object implements 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 Details

    • SORT_BY_READ

      public static final Integer SORT_BY_READ
      Deprecated.
      A constant sort property for notification - sort by read status

    • SORT_BY_ID

      public static final Integer SORT_BY_ID
      Deprecated.
      A constant sort property for notification - sort by id

    • SORT_BY_TIMESTAMP

      public static final Integer SORT_BY_TIMESTAMP
      Deprecated.
      A constant sort property for notification - sort by timestamp

    • SORT_BY_ATTRIBUTES

      public static final Integer SORT_BY_ATTRIBUTES
      Deprecated.
      A constant sort property for notification - sort by attributes

    • SORT_BY_APPLICATION

      public static final Integer SORT_BY_APPLICATION
      Deprecated.
      A constant sort property for notification - sort by application

    • SORT_BY_NOTIFICATION_TYPE

      public static final Integer SORT_BY_NOTIFICATION_TYPE
      Deprecated.
      A constant sort property for notification - sort by notifcation type

    • SORT_BY_STRING_RENDERER

      public static final Integer SORT_BY_STRING_RENDERER
      Deprecated.
      A constant sort property for notification - sort by string renderer

    • SORT_BY_PAGE_RENDERER

      public static final Integer SORT_BY_PAGE_RENDERER
      Deprecated.
      A constant sort property for notification - sort by page renderer

    • SORT_BY_APPLICATION_ICON

      public static final Integer SORT_BY_APPLICATION_ICON
      Deprecated.
      A constant sort property for notification - sort by application icon

    • SORT_BY_TYPE_ICON

      public static final Integer SORT_BY_TYPE_ICON
      Deprecated.
      A constant sort property for notification - sort by type icon

  • Constructor Details

    • Notification

      public Notification()
      Deprecated.

  • Method Details

    • setId

      public void setId(Long p)
      Deprecated.
      see getId()

    • getId

      public Long getId()
      Deprecated.
      the unique identifier of this notification

    • setApplication

      public void setApplication(String p)
      Deprecated.
      see getApplication()

    • getApplication

      public String getApplication()
      Deprecated.
      the name of the application that generated this notification

    • setNotificationType

      public void setNotificationType(String p)
      Deprecated.
      see getNotificationType()

    • getNotificationType

      public String getNotificationType()
      Deprecated.
      the type of notification

    • setTimestamp

      public void setTimestamp(Timestamp p)
      Deprecated.
      see getTimestamp()

    • getTimestamp

      public Timestamp getTimestamp()
      Deprecated.
      the time at which this notification was generated

    • setStringRenderer

      public void setStringRenderer(String p)
      Deprecated.
      see getStringRenderer()

    • getStringRenderer

      public String getStringRenderer()
      Deprecated.
      the uri to call to render this notification as a single line of text

    • setPageRenderer

      public void setPageRenderer(String p)
      Deprecated.
      see getPageRenderer()

    • getPageRenderer

      public String getPageRenderer()
      Deprecated.
      the uri to call to render this notification as an html page

    • setApplicationIcon

      public void setApplicationIcon(String p)
      Deprecated.
      see getApplicationIcon()

    • getApplicationIcon

      public String getApplicationIcon()
      Deprecated.
      the uri of an icon representing the application that generated this notification

    • setTypeIcon

      public void setTypeIcon(String p)
      Deprecated.
      see getTypeIcon()

    • getTypeIcon

      public String getTypeIcon()
      Deprecated.
      the uri of an icon representing the type of this notification

    • setAttributes

      public void setAttributes(Map p)
      Deprecated.
      see getAttributes()

    • getAttributes

      public 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(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 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