com.groiss.notification

Class NotificationEvent

java.lang.Object

java.util.EventObject

com.groiss.notification.NotificationEvent

All Implemented Interfaces:

Serializable

public class NotificationEvent
extends EventObject

Class for events representing changed NotificationItems. Instances are created through the notification subsystem. It is normally not necessary to construct any instances.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Agent	agent
OrgUnit	dept
Long	folderOid

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
NotificationEvent(NotificationItem ni, short type) Constructor
NotificationEvent(NotificationItem ni, short type, Agent agent) Constructor
NotificationEvent(NotificationItem ni, short type, Agent agent, OrgUnit dept) Constructor
NotificationEvent(NotificationItem ni, short type, Agent agent, OrgUnit dept, boolean isObsolete) Constructor

Method Summary

Modifier and Type	Method and Description
long	getCommitTimeStamp() Get the commit time stamp.
long	getCreateTimeStamp() Get the create time stamp.
Long	getFolderOid()
NotificationItem	getNi() Get the NotificationItem the event is transporting.
String	getOriginatingSessionId() Get the id of the sending session.
String	getSessionId() Check, if an event is for private notification without substitution.
int	getType() Get the type of the event.
String	getUniqueServerTag() Get the unique tag of the server.
boolean	isObsolete() Determine if the event is obsolete.
boolean	isPrivate() Check, if an event is for private notification without substitution.
void	markObsolete() Mark event as obsolete.
void	setCommitTimeStamp(long commitTimeStamp) Set the commit time stamp.
void	setFolderOid(Long folderOid)
void	setNi(NotificationItem ni) Set NotificatinoItem the event will transport.
String	setOriginatingSessionId(String sessionid) Sets the id of the originating session
void	setPrivate(boolean isPrivate) Can be used to designate an event for private notification without substitution (all sessions of this user; 'for your eyes only'); agent must be a User.
void	setSessionId(String sessionId) Can be used to designate an event for (very) private notification without substitution for just a single session.
String	setUniqueServerTag(String servertag) Sets the unique tag of the server.
String	toString() Converts a NotificationEvent to a string representation.
void	unmarkObsolete() unmark event as obsolete.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

agent

public Agent agent

dept

public OrgUnit dept

folderOid

public Long folderOid

Constructor Detail

NotificationEvent

public NotificationEvent(NotificationItem ni,
                         short type)

Constructor

Parameters:

ni - the NotificationItem which triggered the notification

type - is ni added or deleted

NotificationEvent

public NotificationEvent(NotificationItem ni,
                         short type,
                         Agent agent)

Constructor

Parameters:

ni - the NotificationItem which triggered the notification

type - is ni added or deleted

agent - the agent the event is destined for.

NotificationEvent

public NotificationEvent(NotificationItem ni,
                         short type,
                         Agent agent,
                         OrgUnit dept)

Constructor

Parameters:

ni - the NotificationItem which triggered the notification

type -

agent - the agent (user or role)

dept - the organizational unit

NotificationEvent

public NotificationEvent(NotificationItem ni,
                         short type,
                         Agent agent,
                         OrgUnit dept,
                         boolean isObsolete)

Constructor

Parameters:

ni - the NotificationItem which triggered the notification

type -

agent - the agent (user or role)

dept - the organizational unit

isObsolete - true, if mail notification should be suppressed

Method Detail

setNi

public void setNi(NotificationItem ni)

Set NotificatinoItem the event will transport.

Parameters:

ni - the item to set

getNi

public NotificationItem getNi()

Get the NotificationItem the event is transporting.

Returns:

the events NotificationItem

markObsolete

public void markObsolete()

Mark event as obsolete. Only applies to items which are StepInstances. Obsolete events are not send via email notification.

unmarkObsolete

public void unmarkObsolete()

unmark event as obsolete. Only applies to items which are StepInstances. Obsolete events are not send via email notification.

isObsolete

public boolean isObsolete()

Determine if the event is obsolete.

Returns:

true if the event is not to be send via email notification.

getUniqueServerTag

public String getUniqueServerTag()

Get the unique tag of the server.

Returns:

the server tag

setUniqueServerTag

public String setUniqueServerTag(String servertag)

Sets the unique tag of the server.

Parameters:

servertag - the id of the server to set

Returns:

the server tag

getOriginatingSessionId

public String getOriginatingSessionId()

Get the id of the sending session.

Returns:

the session id

setOriginatingSessionId

public String setOriginatingSessionId(String sessionid)

Sets the id of the originating session

Parameters:

sessionid - the id of the session to set

Returns:

the session id

getCreateTimeStamp

public long getCreateTimeStamp()

Get the create time stamp.

Returns:

Returns the createTimeStamp.

getCommitTimeStamp

public long getCommitTimeStamp()

Get the commit time stamp.

Returns:

Returns the commitTimeStamp.

setCommitTimeStamp

public void setCommitTimeStamp(long commitTimeStamp)

Set the commit time stamp.

Parameters:

commitTimeStamp - The commitTimeStamp to set.

getType

public int getType()

Get the type of the event.

Returns:

the type of the event

See Also:

Names

getFolderOid

public Long getFolderOid()

setFolderOid

public void setFolderOid(Long folderOid)

setPrivate

public void setPrivate(boolean isPrivate)

Can be used to designate an event for private notification without substitution (all sessions of this user; 'for your eyes only'); agent must be a User.

isPrivate

public boolean isPrivate()

Check, if an event is for private notification without substitution.

setSessionId

public void setSessionId(String sessionId)

Can be used to designate an event for (very) private notification without substitution for just a single session. agent must be a User. Implies isPrivate.

getSessionId

public String getSessionId()

Check, if an event is for private notification without substitution.

toString

public String toString()

Converts a NotificationEvent to a string representation.

Overrides:

toString in class EventObject

Returns:

the string representation of the receiver.