Package oracle.iam.notification.vo

Class NotificationEvent

java.lang.Object
oracle.iam.notification.vo.NotificationEvent
All Implemented Interfaces:
Serializable
public class NotificationEvent extends Object implements Serializable
This object represents a notification event
Author:
saggarwa
See Also:

  • Constructor Details

    • NotificationEvent

      public NotificationEvent(String eventId, String[] userIds, String contextId, String templateName, String description, String sender, HashMap<String,Object> params, Date createdOn, Date validTill)
      Constructor to construct a notification event
      Parameters:
      eventId - ID of the event
      userIds - Array of the receipient's username
      contextId -
      templateName - Template name associated with the event
      description - Description for the event
      sender - Username of the user sending the notification for the event
      params - Map containing attribute-value pair for the parameters corresponding to the event
      createdOn - Date on which event occurs
      validTill - Date till which the event is valid

    • NotificationEvent

      public NotificationEvent(String eventId, String[] userIds, String[] userKeys, String contextId, String templateName, String description, String sender, HashMap<String,Object> params, Date createdOn, Date validTill)
      Constructor to construct a notification event
      Parameters:
      eventId - ID of the event
      userIds - Array of the receipient's username
      userKeys - Array of the receipient's user keys. These values will get preference over User IDs.
      contextId -
      templateName - Template name associated with the event
      description - Description for the event
      sender - Username of the user sending the notification for the event
      params - Map containing attribute-value pair for the parameters corresponding to the event
      createdOn - Date on which event occurs
      validTill - Date till which the event is valid

    • NotificationEvent

      public NotificationEvent(String eventId, String[] userIds, String[] ccIds, String[] bccIds, String templateName, String description, String sender, HashMap<String,Object> params, Date createdOn, Date validTill)
      Constructor to construct a notification event
      Parameters:
      eventId - ID of the event
      userIds - Array of the receipient's username
      ccIds - Array of the cc email Ids.
      bccIds - Array of the bcc email Ids
      templateName - Template name associated with the event
      description - Description for the event
      sender - Username of the user sending the notification for the event
      params - Map containing attribute-value pair for the parameters corresponding to the event
      createdOn - Date on which event occurs
      validTill - Date till which the event is valid

    • NotificationEvent

      public NotificationEvent(String eventId, String[] userIds, String[] userKeys, String[] ccIds, String[] bccIds, String templateName, String description, String sender, HashMap<String,Object> params, Date createdOn, Date validTill)
      Constructor to construct a notification event
      Parameters:
      eventId - ID of the event
      userIds - Array of the receipient's username
      userKeys - Array of the receipient's user keys. These values will get preference over User IDs.
      ccIds - Array of the cc email Ids.
      bccIds - Array of the bcc email Ids
      templateName - Template name associated with the event
      description - Description for the event
      sender - Username of the user sending the notification for the event
      params - Map containing attribute-value pair for the parameters corresponding to the event
      createdOn - Date on which event occurs
      validTill - Date till which the event is valid

    • NotificationEvent

      public NotificationEvent()

  • Method Details

    • getDescription

      public String getDescription()
      Provides Description for the event
      Returns:
      description for the event

    • getUserIds

      public String[] getUserIds()
      Provides the Array of the recepient's username to whom notification is to be sent
      Returns:
      Array of the receipient's username

    • getUserKeys

      public String[] getUserKeys()
      Provides the Array of the recepient's user Keys to whom notification is to be sent. These values will get preference over User IDs.
      Returns:
      Array of the receipient's user Keys

    • getCcEmailIds

      public String[] getCcEmailIds()
      Provides the Array of the recepient's user names who are to be cc'ed in the notification.
      Returns:
      Array of the receipient user names cc'ed list

    • getBccEmailIds

      public String[] getBccEmailIds()
      Provides the Array of the recepient's user names who are to be bcc'ed in the notification.
      Returns:
      Array of the receipient user names in bcc'ed list

    • getCreatedOn

      public Date getCreatedOn()
      Provides the date on which event occurs
      Returns:
      date on which event occurs

    • getTemplateName

      public String getTemplateName()
      Provides template name associated with the event
      Returns:
      template name associated with the event

    • getValidTill

      public Date getValidTill()
      Provides the date till which the event is valid
      Returns:
      date till which event is valid

    • getEventId

      public String getEventId()
      Provides ID of the event
      Returns:
      ID of the event

    • getParams

      public HashMap<String,Object> getParams()
      Provides Map containing attribute-value pair for the parameters corresponding to the event
      Returns:
      Map containing attribute-value pair

    • setParams

      public void setParams(HashMap<String,Object> params)
      Sets value to the parameters corresponding to the event as per Map of attribute-value pair passed
      Parameters:
      params - Map of attribute-value pair

    • setUserIds

      public void setUserIds(String[] userIds)
      Adds recepient's username of the notification for the event
      Parameters:
      userIds - Array of the recepient's username

    • setCcEmailIds

      public void setCcEmailIds(String[] ccEmailIds)
      Adds recepient's user names of the notification for the event. These values will get preference over User IDs.
      Parameters:
      userIds - Array of the recepient's user names

    • setBccEmailIds

      public void setBccEmailIds(String[] bccEmailIds)
      Adds recepient's user names of the notification for the event. These values will get preference over User IDs.
      Parameters:
      userIds - Array of the recepient's user names

    • setUserKeys

      public void setUserKeys(String[] userKeys)
      Adds recepient's user keys of the notification for the event. These values will get preference over User IDs.
      Parameters:
      userIds - Array of the recepient's user keys

    • setCreatedOn

      public void setCreatedOn(Date createdOn)
      Sets date on which the event occurs
      Parameters:
      createdOn - Date object to be set

    • setValidTill

      public void setValidTill(Date validTill)
      Sets date till which the event is valid
      Parameters:
      validTill - Date object till which the event is valid

    • setTemplateName

      public void setTemplateName(String templateName)
      Adds name of the template to be associated with the event
      Parameters:
      templateName - template name to be associated

    • setDescription

      public void setDescription(String description)
      Adds description for the event
      Parameters:
      description - description to be added

    • setEventId

      public void setEventId(String eventId)
      Sets ID for the event
      Parameters:
      eventId - value of ID to be set

    • getSender

      public String getSender()
      Provides username of the user sending the notification for the event
      Returns:
      Sender's username

    • setSender

      public void setSender(String sender)
      Sets username of the user sending the notification for the event
      Parameters:
      sender - Sender's username