oracle.iam.notification.vo

Class NotificationEvent

java.lang.Object

oracle.iam.notification.vo.NotificationEvent

All Implemented Interfaces:

java.io.Serializable

public class NotificationEvent
extends java.lang.Object
implements java.io.Serializable

This object represents a notification event

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NotificationEvent()
NotificationEvent(java.lang.String eventId, java.lang.String[] userIds, java.lang.String[] userKeys, java.lang.String[] ccIds, java.lang.String[] bccIds, java.lang.String templateName, java.lang.String description, java.lang.String sender, java.util.HashMap params, java.util.Date createdOn, java.util.Date validTill) Constructor to construct a notification event
NotificationEvent(java.lang.String eventId, java.lang.String[] userIds, java.lang.String[] ccIds, java.lang.String[] bccIds, java.lang.String templateName, java.lang.String description, java.lang.String sender, java.util.HashMap params, java.util.Date createdOn, java.util.Date validTill) Constructor to construct a notification event
NotificationEvent(java.lang.String eventId, java.lang.String[] userIds, java.lang.String[] userKeys, java.lang.String contextId, java.lang.String templateName, java.lang.String description, java.lang.String sender, java.util.HashMap params, java.util.Date createdOn, java.util.Date validTill) Constructor to construct a notification event
NotificationEvent(java.lang.String eventId, java.lang.String[] userIds, java.lang.String contextId, java.lang.String templateName, java.lang.String description, java.lang.String sender, java.util.HashMap params, java.util.Date createdOn, java.util.Date validTill) Constructor to construct a notification event

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getBccEmailIds() Provides the Array of the recepient's user names who are to be bcc'ed in the notification.
java.lang.String[]	getCcEmailIds() Provides the Array of the recepient's user names who are to be cc'ed in the notification.
java.util.Date	getCreatedOn() Provides the date on which event occurs
java.lang.String	getDescription() Provides Description for the event
java.lang.String	getEventId() Provides ID of the event
java.util.HashMap	getParams() Provides Map containing attribute-value pair for the parameters corresponding to the event
java.lang.String	getSender() Provides username of the user sending the notification for the event
java.lang.String	getTemplateName() Provides template name associated with the event
java.lang.String[]	getUserIds() Provides the Array of the recepient's username to whom notification is to be sent
java.lang.String[]	getUserKeys() Provides the Array of the recepient's user Keys to whom notification is to be sent.
java.util.Date	getValidTill() Provides the date till which the event is valid
void	setBccEmailIds(java.lang.String[] bccEmailIds) Adds recepient's user names of the notification for the event.
void	setCcEmailIds(java.lang.String[] ccEmailIds) Adds recepient's user names of the notification for the event.
void	setCreatedOn(java.util.Date createdOn) Sets date on which the event occurs
void	setDescription(java.lang.String description) Adds description for the event
void	setEventId(java.lang.String eventId) Sets ID for the event
void	setParams(java.util.HashMap params) Sets value to the parameters corresponding to the event as per Map of attribute-value pair passed
void	setSender(java.lang.String sender) Sets username of the user sending the notification for the event
void	setTemplateName(java.lang.String templateName) Adds name of the template to be associated with the event
void	setUserIds(java.lang.String[] userIds) Adds recepient's username of the notification for the event
void	setUserKeys(java.lang.String[] userKeys) Adds recepient's user keys of the notification for the event.
void	setValidTill(java.util.Date validTill) Sets date till which the event is valid

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationEvent

public NotificationEvent(java.lang.String eventId,
                         java.lang.String[] userIds,
                         java.lang.String contextId,
                         java.lang.String templateName,
                         java.lang.String description,
                         java.lang.String sender,
                         java.util.HashMap params,
                         java.util.Date createdOn,
                         java.util.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(java.lang.String eventId,
                         java.lang.String[] userIds,
                         java.lang.String[] userKeys,
                         java.lang.String contextId,
                         java.lang.String templateName,
                         java.lang.String description,
                         java.lang.String sender,
                         java.util.HashMap params,
                         java.util.Date createdOn,
                         java.util.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(java.lang.String eventId,
                         java.lang.String[] userIds,
                         java.lang.String[] ccIds,
                         java.lang.String[] bccIds,
                         java.lang.String templateName,
                         java.lang.String description,
                         java.lang.String sender,
                         java.util.HashMap params,
                         java.util.Date createdOn,
                         java.util.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(java.lang.String eventId,
                         java.lang.String[] userIds,
                         java.lang.String[] userKeys,
                         java.lang.String[] ccIds,
                         java.lang.String[] bccIds,
                         java.lang.String templateName,
                         java.lang.String description,
                         java.lang.String sender,
                         java.util.HashMap params,
                         java.util.Date createdOn,
                         java.util.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 Detail

getDescription

public java.lang.String getDescription()

Provides Description for the event

Returns:

description for the event

getUserIds

public java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.Date getCreatedOn()

Provides the date on which event occurs

Returns:

date on which event occurs

getTemplateName

public java.lang.String getTemplateName()

Provides template name associated with the event

Returns:

template name associated with the event

getValidTill

public java.util.Date getValidTill()

Provides the date till which the event is valid

Returns:

date till which event is valid

getEventId

public java.lang.String getEventId()

Provides ID of the event

Returns:

ID of the event

getParams

public java.util.HashMap getParams()

Provides Map containing attribute-value pair for the parameters corresponding to the event

Returns:

Map containing attribute-value pair

setParams

public void setParams(java.util.HashMap 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(java.lang.String[] userIds)

Adds recepient's username of the notification for the event

Parameters:

userIds - Array of the recepient's username

setCcEmailIds

public void setCcEmailIds(java.lang.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(java.lang.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(java.lang.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(java.util.Date createdOn)

Sets date on which the event occurs

Parameters:

createdOn - Date object to be set

setValidTill

public void setValidTill(java.util.Date validTill)

Sets date till which the event is valid

Parameters:

validTill - Date object till which the event is valid

setTemplateName

public void setTemplateName(java.lang.String templateName)

Adds name of the template to be associated with the event

Parameters:

templateName - template name to be associated

setDescription

public void setDescription(java.lang.String description)

Adds description for the event

Parameters:

description - description to be added

setEventId

public void setEventId(java.lang.String eventId)

Sets ID for the event

Parameters:

eventId - value of ID to be set

getSender

public java.lang.String getSender()

Provides username of the user sending the notification for the event

Returns:

Sender's username

setSender

public void setSender(java.lang.String sender)

Sets username of the user sending the notification for the event

Parameters:

sender - Sender's username