Package oracle.iam.notification.vo
Class NotificationEvent
java.lang.Object
oracle.iam.notification.vo.NotificationEvent
- All Implemented Interfaces:
Serializable
This object represents a notification event
- Author:
- saggarwa
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionNotificationEvent
(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 eventNotificationEvent
(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 eventNotificationEvent
(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 eventNotificationEvent
(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 -
Method Summary
Modifier and TypeMethodDescriptionString[]
Provides theArray
of the recepient's user names who are to be bcc'ed in the notification.String[]
Provides theArray
of the recepient's user names who are to be cc'ed in the notification.Provides the date on which event occursProvides Description for the eventProvides ID of the eventProvidesMap
containing attribute-value pair for the parameters corresponding to the eventProvides username of the user sending the notification for the eventProvides template name associated with the eventString[]
Provides theArray
of the recepient's username to whom notification is to be sentString[]
Provides theArray
of the recepient's user Keys to whom notification is to be sent.Provides the date till which the event is validvoid
setBccEmailIds
(String[] bccEmailIds) Adds recepient's user names of the notification for the event.void
setCcEmailIds
(String[] ccEmailIds) Adds recepient's user names of the notification for the event.void
setCreatedOn
(Date createdOn) Sets date on which the event occursvoid
setDescription
(String description) Adds description for the eventvoid
setEventId
(String eventId) Sets ID for the eventvoid
Sets value to the parameters corresponding to the event as perMap
of attribute-value pair passedvoid
Sets username of the user sending the notification for the eventvoid
setTemplateName
(String templateName) Adds name of the template to be associated with the eventvoid
setUserIds
(String[] userIds) Adds recepient's username of the notification for the eventvoid
setUserKeys
(String[] userKeys) Adds recepient's user keys of the notification for the event.void
setValidTill
(Date validTill) Sets date till which the event is valid
-
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 eventuserIds
-Array
of the receipient's usernamecontextId
-templateName
- Template name associated with the eventdescription
- Description for the eventsender
- Username of the user sending the notification for the eventparams
-Map
containing attribute-value pair for the parameters corresponding to the eventcreatedOn
- Date on which event occursvalidTill
- 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 eventuserIds
-Array
of the receipient's usernameuserKeys
-Array
of the receipient's user keys. These values will get preference over User IDs.contextId
-templateName
- Template name associated with the eventdescription
- Description for the eventsender
- Username of the user sending the notification for the eventparams
-Map
containing attribute-value pair for the parameters corresponding to the eventcreatedOn
- Date on which event occursvalidTill
- 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 eventuserIds
-Array
of the receipient's usernameccIds
-Array
of the cc email Ids.bccIds
-Array
of the bcc email IdstemplateName
- Template name associated with the eventdescription
- Description for the eventsender
- Username of the user sending the notification for the eventparams
-Map
containing attribute-value pair for the parameters corresponding to the eventcreatedOn
- Date on which event occursvalidTill
- 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 eventuserIds
-Array
of the receipient's usernameuserKeys
-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 IdstemplateName
- Template name associated with the eventdescription
- Description for the eventsender
- Username of the user sending the notification for the eventparams
-Map
containing attribute-value pair for the parameters corresponding to the eventcreatedOn
- Date on which event occursvalidTill
- Date till which the event is valid
-
NotificationEvent
public NotificationEvent()
-
-
Method Details
-
getDescription
Provides Description for the event- Returns:
- description for the event
-
getUserIds
Provides theArray
of the recepient's username to whom notification is to be sent- Returns:
Array
of the receipient's username
-
getUserKeys
Provides theArray
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
Provides theArray
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
Provides theArray
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
Provides the date on which event occurs- Returns:
- date on which event occurs
-
getTemplateName
Provides template name associated with the event- Returns:
- template name associated with the event
-
getValidTill
Provides the date till which the event is valid- Returns:
- date till which event is valid
-
getEventId
Provides ID of the event- Returns:
- ID of the event
-
getParams
ProvidesMap
containing attribute-value pair for the parameters corresponding to the event- Returns:
Map
containing attribute-value pair
-
setParams
Sets value to the parameters corresponding to the event as perMap
of attribute-value pair passed- Parameters:
params
-Map
of attribute-value pair
-
setUserIds
Adds recepient's username of the notification for the event- Parameters:
userIds
-Array
of the recepient's username
-
setCcEmailIds
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
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
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
Sets date on which the event occurs- Parameters:
createdOn
- Date object to be set
-
setValidTill
Sets date till which the event is valid- Parameters:
validTill
- Date object till which the event is valid
-
setTemplateName
Adds name of the template to be associated with the event- Parameters:
templateName
- template name to be associated
-
setDescription
Adds description for the event- Parameters:
description
- description to be added
-
setEventId
Sets ID for the event- Parameters:
eventId
- value of ID to be set
-
getSender
Provides username of the user sending the notification for the event- Returns:
- Sender's username
-
setSender
Sets username of the user sending the notification for the event- Parameters:
sender
- Sender's username
-