wt.workflow.engine
Class WfAssigneeNotification

java.lang.Object
  wt.workflow.engine.WfAssigneeNotification

All Implemented Interfaces:

Evolvable, Externalizable, Serializable

public class WfAssigneeNotification

extends Object

implements Evolvable

This class is to be used for variable modification of the parameters associated with overdue (eg. deadline) assignee notifications. It does not allow for modification to the defined Roles to be notified at the actual deadline (eg. the Assignees). It simply allows one to set or unset whether to notify the Assignee roles defined in the workflow deadline tab; and whether to notify the Responsible Role. It also allows one to change the offsets, in days, for Approaching and Past deadline notifications. If these items are set in the workflow template's deadline tab, those values will be used as defaults to populate the defaults of this variables attributes. This variable's default values are zero days and false (no notification).

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static int	MILLIS_IN_DAY
private boolean	notifyAssignees
private boolean	notifyResponsibleRole
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private int	timeAfterDeadline
private int	timeAfterDeadlineAssignees
private int	timeBeforeDeadline
private int	timeBeforeDeadlineAssignees

Constructor Summary

WfAssigneeNotification()
Creates a WfDueDate - no arg contructor.

WfAssigneeNotification(boolean notify_assignees, int days_prior_assignees, int days_after_assignees, boolean notify_responsible, int days_prior, int days_after)
Creates a WfAssigneeNotification specifying whether to notify Assignees and/or ResponsibleRole, and applicable notification times (days) before and/or after deadline specified.

WfAssigneeNotification(String whoAndWhen)
Creates a WfAssigneeNotification specifying whether to notify Assignees and/or ResponsibleRole, and applicable notification times (days) before and/or after deadline specified as strings.

Method Summary

private int	cleanIntValue(int i)
private int	cleanStringValue(String s)
WfAssigneeNotification	copy()
String	debugOutput()
int	getTimeAfterDeadline() Gets the value of the attribute: timeAfterDeadline; send past deadline message 'n' days before Supported API: false
int	getTimeAfterDeadlineAssignees() Gets the value of the attribute: timeAfterDeadlineAssignees; send past deadline message 'n' days before Supported API: false
long	getTimeAfterDeadlineAssigneesInMillis()
long	getTimeAfterDeadlineInMillis()
int	getTimeBeforeDeadline() Gets the value of the attribute: timeBeforeDeadline; send approaching deadline message 'n' days before Supported API: false
int	getTimeBeforeDeadlineAssignees() Gets the value of the attribute: timeBeforeDeadlineAssignees; send approaching deadline message 'n' days before Supported API: false
long	getTimeBeforeDeadlineAssigneesInMillis()
long	getTimeBeforeDeadlineInMillis()
boolean	isNotifyAssignees() Gets the value of the attribute: notifyAssignees; set whether the task recipients having uncompleted tasks are notified.
boolean	isNotifyResponsibleRole() Gets the value of the attribute: notifyResponsibleRole; set if Responsible Role is notified.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(WfAssigneeNotification thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setNotifyAssignees(boolean a_NotifyAssignees) Sets the value of the attribute: notifyAssignees; set whether the task recipients having uncompleted tasks are notified.
void	setNotifyResponsibleRole(boolean a_NotifyResponsibleRole) Sets the value of the attribute: notifyResponsibleRole; set if Responsible Role is notified.
void	setTimeAfterDeadline(int a_TimeAfterDeadline) Sets the value of the attribute: timeAfterDeadline; send past deadline message 'n' days before Supported API: false
void	setTimeAfterDeadlineAssignees(int a_TimeAfterDeadlineAssignees) Sets the value of the attribute: timeAfterDeadlineAssignees; send past deadline message 'n' days before Supported API: false
void	setTimeBeforeDeadline(int a_TimeBeforeDeadline) Sets the value of the attribute: timeBeforeDeadline; send approaching deadline message 'n' days before Supported API: false
void	setTimeBeforeDeadlineAssignees(int a_TimeBeforeDeadlineAssignees) Sets the value of the attribute: timeBeforeDeadlineAssignees; send approaching deadline message 'n' days before Supported API: false
String	toString() Supported API: false
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

notifyAssignees

private boolean notifyAssignees

timeBeforeDeadlineAssignees

private int timeBeforeDeadlineAssignees

timeAfterDeadlineAssignees

private int timeAfterDeadlineAssignees

notifyResponsibleRole

private boolean notifyResponsibleRole

timeBeforeDeadline

private int timeBeforeDeadline

timeAfterDeadline

private int timeAfterDeadline

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

MILLIS_IN_DAY

public static final int MILLIS_IN_DAY

See Also:

Constant Field Values

Constructor Detail

WfAssigneeNotification

public WfAssigneeNotification()

Creates a WfDueDate - no arg contructor.

Supported API: false

WfAssigneeNotification

public WfAssigneeNotification(boolean notify_assignees,
                              int days_prior_assignees,
                              int days_after_assignees,
                              boolean notify_responsible,
                              int days_prior,
                              int days_after)

Creates a WfAssigneeNotification specifying whether to notify Assignees and/or ResponsibleRole, and applicable notification times (days) before and/or after deadline specified.

Supported API: false

Parameters:

notify_assignees - Set whether the task Assignees should recieve deadline notifications.

days_prior_assignees - Integer specifying how many days before the Assignees should be notified of the impending deadline.

days_after_assignees - Integer specifying how many days following the Assignees should be notified of the expired deadline if the object is not yet complete.

notify_responsible - Set whether the Responsible Role should recieve deadline notifications.

days_prior - Integer specifying how many days before the Responsible Role should be notified of the impending deadline.

days_after - Integer specifying how many days following the Responsible Role should be notified of the expired deadline if the object is not yet complete.

WfAssigneeNotification

public WfAssigneeNotification(String whoAndWhen)

Creates a WfAssigneeNotification specifying whether to notify Assignees and/or ResponsibleRole, and applicable notification times (days) before and/or after deadline specified as strings.

Supported API: false

Parameters:

whoAndWhen - This String is a comma separated list values used to construct this object. Example: true,2,1,true,3,1 The order is: notify_assignees, days_prior_assignees, days_after_assignees, notify_responsible, days_prior, days_after

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WfAssigneeNotification thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

isNotifyAssignees

public boolean isNotifyAssignees()

Gets the value of the attribute: notifyAssignees; set whether the task recipients having uncompleted tasks are notified.

Supported API: false

Returns:

boolean

setNotifyAssignees

public void setNotifyAssignees(boolean a_NotifyAssignees)
                        throws WTPropertyVetoException

Sets the value of the attribute: notifyAssignees; set whether the task recipients having uncompleted tasks are notified.

Supported API: false

Parameters:

a_NotifyAssignees -

Throws:

WTPropertyVetoException

getTimeBeforeDeadlineAssignees

public int getTimeBeforeDeadlineAssignees()

Gets the value of the attribute: timeBeforeDeadlineAssignees; send approaching deadline message 'n' days before

Supported API: false

Returns:

int

setTimeBeforeDeadlineAssignees

public void setTimeBeforeDeadlineAssignees(int a_TimeBeforeDeadlineAssignees)
                                    throws WTPropertyVetoException

Sets the value of the attribute: timeBeforeDeadlineAssignees; send approaching deadline message 'n' days before

Supported API: false

Parameters:

a_TimeBeforeDeadlineAssignees -

Throws:

WTPropertyVetoException

getTimeAfterDeadlineAssignees

public int getTimeAfterDeadlineAssignees()

Gets the value of the attribute: timeAfterDeadlineAssignees; send past deadline message 'n' days before

Supported API: false

Returns:

int

setTimeAfterDeadlineAssignees

public void setTimeAfterDeadlineAssignees(int a_TimeAfterDeadlineAssignees)
                                   throws WTPropertyVetoException

Sets the value of the attribute: timeAfterDeadlineAssignees; send past deadline message 'n' days before

Supported API: false

Parameters:

a_TimeAfterDeadlineAssignees -

Throws:

WTPropertyVetoException

isNotifyResponsibleRole

public boolean isNotifyResponsibleRole()

Gets the value of the attribute: notifyResponsibleRole; set if Responsible Role is notified.

Supported API: false

Returns:

boolean

setNotifyResponsibleRole

public void setNotifyResponsibleRole(boolean a_NotifyResponsibleRole)
                              throws WTPropertyVetoException

Sets the value of the attribute: notifyResponsibleRole; set if Responsible Role is notified.

Supported API: false

Parameters:

a_NotifyResponsibleRole -

Throws:

WTPropertyVetoException

getTimeBeforeDeadline

public int getTimeBeforeDeadline()

Gets the value of the attribute: timeBeforeDeadline; send approaching deadline message 'n' days before

Supported API: false

Returns:

int

setTimeBeforeDeadline

public void setTimeBeforeDeadline(int a_TimeBeforeDeadline)
                           throws WTPropertyVetoException

Sets the value of the attribute: timeBeforeDeadline; send approaching deadline message 'n' days before

Supported API: false

Parameters:

a_TimeBeforeDeadline -

Throws:

WTPropertyVetoException

getTimeAfterDeadline

public int getTimeAfterDeadline()

Gets the value of the attribute: timeAfterDeadline; send past deadline message 'n' days before

Supported API: false

Returns:

int

setTimeAfterDeadline

public void setTimeAfterDeadline(int a_TimeAfterDeadline)
                          throws WTPropertyVetoException

Sets the value of the attribute: timeAfterDeadline; send past deadline message 'n' days before

Supported API: false

Parameters:

a_TimeAfterDeadline -

Throws:

WTPropertyVetoException

toString

public String toString()

Supported API: false

Returns:

String

debugOutput

public String debugOutput()

getTimeBeforeDeadlineInMillis

public long getTimeBeforeDeadlineInMillis()

getTimeAfterDeadlineInMillis

public long getTimeAfterDeadlineInMillis()

getTimeBeforeDeadlineAssigneesInMillis

public long getTimeBeforeDeadlineAssigneesInMillis()

getTimeAfterDeadlineAssigneesInMillis

public long getTimeAfterDeadlineAssigneesInMillis()

cleanIntValue

private int cleanIntValue(int i)

cleanStringValue

private int cleanStringValue(String s)

copy

public WfAssigneeNotification copy()